Update Group

PUT {{apiPath}}/environments/{{envID}}/groups/{{groupID}}

The PUT /environments/{{envID}}/groups/{{groupID}} operation updates one group.

Important: You cannot update population.id with this operation. This property is read-only after a group is created. For more information, see Creating groups.

Prerequisites

• See Groups for important overview information.

See the Groups data model for full property descriptions.

Request Body

{"name"=>"MyGroupName1", "description"=>"This is a group for testing.", "externalId"=>"cn=Some Group,ou=groups,dc=some,dc=active-directory,dc=domain", "customData"=>{"groupOwnwer"=>"Bill Sample", "securityGroup"=>true}, "userFilter"=>"title eq \"Manager\""}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/bb0756de-b2ac-412b-81d4-20d2f111fb4d"},"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%22bb0756de-b2ac-412b-81d4-20d2f111fb4d%22%5D"},"directUserMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users?filter=memberOfGroups%5Bid%20eq%20%22bb0756de-b2ac-412b-81d4-20d2f111fb4d%22%20and%20type%20eq%20%22DIRECT%22%5D"},"allGroupMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22bb0756de-b2ac-412b-81d4-20d2f111fb4d%22%5D"},"directGroupMembers":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups?filter=memberOfGroups%5Bid%20eq%20%22bb0756de-b2ac-412b-81d4-20d2f111fb4d%22%20and%20type%20eq%20%22DIRECT%22%5D"}},"id":"bb0756de-b2ac-412b-81d4-20d2f111fb4d","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"MyGroupName1","description":"This is a group for testing.","externalId":"cn=Some Group,ou=groups,dc=some,dc=active-directory,dc=domain","customData":{"groupOwnwer":"Bill Sample","securityGroup":true},"directMemberCounts":{"users":0,"groups":0},"createdAt":"2023-03-23T18:32:49.737Z","updatedAt":"2023-03-23T18:33:30.256Z","checkSum":"15155775465","userFilter":"title eq \"Manager\""}