Grist Octri Preview
GET/scim/v2/Groups

List SCIM groups

Lists groups available through the SCIM service. Use filter to narrow the results and startIndex and count to control pagination.

3 parameters
startIndexintegeroptional
The starting index for pagination.
countintegeroptional
The number of groups to retrieve.
filterstringoptional
A SCIM filter expression for narrowing the groups returned.

4 status codes
200Returns a SCIM list response containing group resources, the starting index, the number of groups returned per page, and the total number of groups.
Resourcesarray<object>optional
itemsPerPageintegeroptional
Number of groups returned per page.
schemasarray<string>optional
startIndexintegeroptional
Starting index.
totalResultsintegeroptional
Total number of groups.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request is unauthenticated, and a 403 is returned when the request is unauthorized. A 500 is returned when an internal server error occurs; use startIndex, count, and filter to specify the requested results.