Step 1: Create a group

POST {{apiPath}}/environments/{{envID}}/groups

This example shows the POST /environments/{{envID}}/groups operation to create a new user group.

In this request:

  • {{envID}} represents your environment ID.

  • The request body requires the name property. The description property is optional.

  • The userFilter property defines a filter to dynamically add users to a group. In this case, the user's type property is set to SAMLuser. The user is then assigned membership to this group automatically.

  • The request returns a Status: 201 created message and shows the new group's configuration data.

  • The response data includes the group's id property. This property value is needed to implement the accessControl feature in the SAML application.

See the following topics to learn more about populations:

Request Body

{"name"=>"SAML_Users{{$timestamp}}", "description"=>"SAML app users group", "customData"=>{"groupOwner"=>"Tom Jones", "securityGroup"=>true}, "userFilter"=>"type eq \"SAMLuser\""}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring