Create Sign-On Policy Action (IDENTITY_PROVIDER)
POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions
The POST /environments/{{envID}}/signOnPolicies/{{policyID}}/actions operation creates a new sign-on policy action resource. The priority property specifies the order in which this action (and its conditions) is evaluated when evaluating the policy. Property values range from 1 to {maxInt}. The action with a priority value of 1 is evaluated first.
Note: The condition property for the sign-on policy action specifies the conditions associated with the action. At least one condition must be met to execute the action. If the conditions attribute is omitted from the sign-on policy action, the action is always executed.
The sample shows the request for an IDENTITY_PROVIDER action type.
Prerequisites
See Sign-On Policies and Sign-On Policy Actions for important overview information.
Create a sign-on policy to get a
policyIDfor the endpoint.Create an identity provider to get a
providerIDfor the body. See also Identity Provider Management, especially Identity Providers.Create a population to get a
popIDfor the body. See also Populations.
| Property | Type | Required? |
|---|---|---|
identityProvider.id | String | Required |
passUserContext | Boolean | Required |
priority | Integer | Required |
registration.confirmIdentityProviderAttributes | Boolean | Optional |
registration.enabled | Boolean | Required |
registration.population.id | String | Required |
See the Sign-on policy actions base data model for full property descriptions.
Request Body
{"type"=>"IDENTITY_PROVIDER", "identityProvider"=>{"id"=>"{{idpID}}"}, "condition"=>{"greater"=>600, "secondsSince"=>"${session.lastSignOn.withAuthenticator.pwd.at}"}, "priority"=>10, "passUserContext"=>true, "registration"=>{"enabled"=>true, "confirmIdentityProviderAttributes"=>true, "population"=>{"id"=>"{{popID}}"}}}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/c7f4211d-25c8-4f92-8e1f-396555875d11/actions/0198f203-5fef-47c1-b3e2-8b12e0c8b956"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"signOnPolicy":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/c7f4211d-25c8-4f92-8e1f-396555875d11"}},"id":"0198f203-5fef-47c1-b3e2-8b12e0c8b956","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"type":"AGREEMENT","signOnPolicy":{"id":"c7f4211d-25c8-4f92-8e1f-396555875d11"},"priority":50,"agreement":{"id":"8d1239bc-33c4-4ffb-bb4e-0cf1d938c93e"},"disableDeclineOption":false}