Groups REST Endpoints

Sort by

Task Path Method

Identity/Groups

Manage all group administrative tasks. A group contains one or more users and works as a role for the enterprise to apply security features.When requesting Group members, a max of 10,000 members will be returned in a single request. If there are more than 10,000 members, the members request will fail. It is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.

Create a Group

Method: post

Path: /admin/v1/Groups

Delete a Group

Method: delete

Path: /admin/v1/Groups/{id}

Get a Group - The Group search and get operations on users/members will throw an exception if it has more than 10K members, to avoid the exception use the pagination filter to get or search group members

Method: get

Path: /admin/v1/Groups/{id}

HTTP Options

Method: options

Path: /admin/v1/Groups

Replace a Group

Method: put

Path: /admin/v1/Groups/{id}

Search Groups Using POST

Method: post

Path: /admin/v1/Groups/.search

Search Groups.The Group search and get operations on users/members will throw an exception if it has more than 10K members, to avoid the exception use the pagination filter to get or search group members

Method: get

Path: /admin/v1/Groups

Update a Group

Method: patch

Path: /admin/v1/Groups/{id}