Create Sign-On Policy
POST {{apiPath}}/environments/{{envID}}/signOnPolicies
The POST /environments/{{envID}}/signOnPolicies operation creates a new sign-on policy resource. In the request body, the name property is required, and the sign-on policy name must be unique within the environment. All other properties are optional.
The default property is set automatically to false. You can't set default to true when you first create the sign-on policy. You'll need to use PUT {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}} to set default to true.
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"=>"Simple_Login", "default"=>"false", "description"=>"A new basic sign-on policy."}
RESPONSES
status: Created
{"_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":"false","description":"A new basic sign-on policy.","name":"Simple_Login"}