Grist Octri Preview
POST/scim/v2/Groups/.search

Search SCIM groups

Searches SCIM groups using a request body of search criteria. Use filter to select matching groups, attributes or excludedAttributes to control returned fields, and startIndex and count for pagination.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

SCIM search criteria for selecting groups and controlling which attributes are returned.

attributesunknownoptional
Names of resource attributes to include in the response.
countintegeroptional
The number of resources to retrieve.
excludedAttributesunknownoptional
Names of resource attributes to exclude from the default response attributes.
filterunknownoptional
A filter expression for selecting groups.
schemasarray<string>optional
The SCIM search request schema identifier: `urn:ietf:params:scim:api:messages:2.0:SearchRequest`.
sortByunknownoptional
The field to sort the matching groups by.
sortOrderstringoptional
Order of sorting (ascending or descending).
startIndexintegeroptional
The starting index for pagination.

5 status codes
200Returns a SCIM list response containing the matching group resources and the total number of groups found.
Resourcesarray<object>optional
schemasarray<string>optional
totalResultsintegeroptional
Total number of groups found.
400Returned when the search request is invalid.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the search request is invalid; schemas must contain urn:ietf:params:scim:api:messages:2.0:SearchRequest. A 401 is returned when the request is unauthenticated, and a 403 is returned when it is unauthorized. A 500 is returned when an internal server error occurs; use filter, startIndex, and count to define the search and result range.