Step 11: Create the agreement sign-on policy action

POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{agreementSignonPolicyID}}/actions

This step associates a sign-on policy action with the new sign-on policy you created in Step 9. The POST /environments/{{envID}}/signOnPolicies/{{policyID}}/actions operation creates the sign-on policy action resource, which is associated with the sign-on policy specified in the request URL.

PingOne includes an AGREEMENT sign-on policy action type that prompts users to provide consent to an agreement before completing the sign-on flow.

In this sample, the priority property is set to 10, which is not the highest ranking. Setting the priority to a higher number than the LOGIN action designates that this policy action executes after the LOGIN action.

Request Body

{"priority"=>50, "agreement"=>{"id"=>"{{agreeID}}"}, "type"=>"AGREEMENT"}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring