Create Group
POST {{apiPath}}/environments/{{envID}}/groups
The POST /environments/{{envID}}/groups operation creates one group.
By default, groups are created per environment. Optionally, you can also create groups per population. For more information, see Creating groups.
Prerequisites
- See Groups for important overview information.
See the Groups data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
customData | JSON blob | Optional |
description | String | Optional |
externalId | String | Optional |
name | String | Required |
population.id | String | Optional |
userFilter | String | Optional |
Request Body
{"name"=>"Managers", "description"=>"This is a test group", "customData"=>{"groupOwner"=>"Tom Jones", "securityGroup"=>true}, "userFilter"=>"title eq \"Manager\""}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/dbd479cb-fcd3-4c34-b5d3-ee2b60c86067"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"allUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22dbd479cb-fcd3-4c34-b5d3-ee2b60c86067%22%5D"},"directUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22dbd479cb-fcd3-4c34-b5d3-ee2b60c86067%22%20and%20type%20eq%20%22DIRECT%22%5D"}},"id":"dbd479cb-fcd3-4c34-b5d3-ee2b60c86067","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Managers","description":"This is a test group","customData":{"groupOwner":"Tom Jones","securityGroup":true},"createdAt":"2021-05-21T22:34:09.539Z","updatedAt":"2021-05-21T22:34:09.539Z","userFilter":"title eq \"Manager\""}