Step 3: Create the sign-on policy

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

Use the POST /environments/{{envID}}/signOnPolicies endpoint to create the new sign-on policy.

In the request:

  • name is required and must be unique within the environment.

  • description is optional, but recommended.

The response shows the property data for the new sign-on policy. It includes an actions link to the sign-on policy actions endpoint. This is used to assign an action to the new sign-on policy. The policy must have at least one associated action before it can be assigned to an application.

Request Body

{"name"=>"SAML-SignOn_Policy{{$timestamp}}", "default"=>"false", "description"=>"A sign-on policy for a SAML application."}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring