Grist Octri Preview
GET/scim/v2/Users

List SCIM users

Lists SCIM users and returns them in a paginated list response. Use startIndex and count to control pagination, and filter to narrow the results.

3 parameters
startIndexintegeroptional
The starting index for pagination.
countintegeroptional
The number of user resources to retrieve.
filterstringoptional
A filter expression for selecting user resources.

4 status codes
200Returns a SCIM list response with user resources, the number of users returned per page, the starting index, and the total number of users.
Resourcesarray<object>optional
itemsPerPageintegeroptional
Number of users returned per page.
schemasarray<string>optional
startIndexintegeroptional
Starting index.
totalResultsintegeroptional
Total number of users.
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. A 403 is returned when the request is unauthorized. A 500 indicates an internal server error; use startIndex, count, and filter as query parameters when requesting users.