HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Retrieves a list of groups that belong to the specified tenant and match the search criteria.

get
https://{tenanturl}/v2.0/Groups

Entitlement required: readUserGroups (Read users and groups), or manageUserGroups (Manage users and groups), or manageAllUserGroups (Synchronize users and groups), or manageUserStandardGroups (Manage users and standard groups).
Note: You only need one entitlement, but you can have more than one.

The members attribute is not returned in the response.

Searching, sorting, paging, and filtering are supported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
string

The SCIM compliant search filter. For example, displayName eq "admin". The filter should be no longer than 4096 characters in length.

string

The list of attributes that are passed in as comma-separated values that are used when passing the result back to the caller. To improve performance, specify in the list only the attributes that you want returned. If no list is provided, the default action is to return all attributes.

string

Specifies the maximum number of query results per page. A negative value is interpreted as 0. A value of 0 indicates that no resource results are to be returned, except for totalResults.

string

A 1-based index that indicates the start index that is used when the number of groups is returned. A value less than 1 is interpreted as 1.

string

Sort the results by the specified criteria when the groups are returned.

string
enum

The sorting order when the number of groups is returned.

Allowed:
string

A string that is searched for in the group records.

Responses

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/scim+json

Updated over 2 years ago