Update Sign-On Policy
PUT {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}
The PUT /environments/{{envID}}/signOnPolicies/{{policyID}}
operation updates the sign-on policy resource specified by its ID in the request URL.
Prerequisites
- See Sign-On Policies for important overview information.
Property | Type | Required? |
---|---|---|
default | Boolean | Required |
description | String | Optional |
name | String | Required |
See the Sign-on policies data model for full property descriptions.
Request Body
{"name"=>"Updated_Policy", "description"=>"a sign-on policy that has been updated", "default"=>true}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/7bf52bba-ef9a-47ac-9163-4310f3208409"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"actions":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/7bf52bba-ef9a-47ac-9163-4310f3208409/actions"}},"id":"7bf52bba-ef9a-47ac-9163-4310f3208409","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"default":"true","description":"A more complex sign-on policy.","name":"Complex_Login"}