Use this endpoint to retrieve all the groups from a tenant or supply a filter to retrieve a subset of groups matching the filter criteria. Please refer to Retrieve all users || Retrieve users matching certain criteria section for the detailed explanation of filtering and supported operators.
The results are paginated with 10 records per page.
SCOPES
Requires one:
seismic.user.view(OAuth scope for read-only access to view groups),seismic.user.manage(OAuth scope for full access to manage groups) See Permissions for additional details.
Terminology
-
GUID: Globally Unique Identifier format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) used for group IDs. Example:
76a01ceb-1cdf-4cfe-a02d-a20c702052c4 -
Resources: SCIM array of group objects (equivalent to
entriesin Seismic pagination standards) -
startIndex: 1-based pagination index
Pagination
This endpoint uses SCIM pagination semantics. The response uses Resources array .
Supported pagination parameters
| Parameter | Description | Default |
|---|---|---|
| startIndex | The 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. | 1 |
| count | Non-negative integer. Specifies the desired maximum number of query results per page, e.g., 10. A negative value SHALL be interpreted as "0". A value of "0" indicates that no resource results are to be returned except for "totalResults". Maps to Seismic limit. | Default number is 10, Maximum number is 100 |
Pagination metadata
| Element | Description |
|---|---|
| Resources | Array of group resources (equivalent to entries in Seismic pagination standards) |
| itemsPerPage | Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10. |
| totalResults | Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000. |
| startIndex | The 1-based index of the first result in the current set of query results, e.g., 1. |
Note: there's currently no support for sorting operators.