Skip to main content
POST
Search groups with a request body

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion console. Write operations require a key with readWrite access level; GET and .search work with read access level.

Body

RFC 7644 §3.4.3 search request.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
filter
string
sortBy
string
sortOrder
enum<string>
Available options:
ascending,
descending
startIndex
integer
Required range: x >= 1
count
integer
Required range: 0 <= x <= 1000
attributes
string[]
excludedAttributes
string[]

Response

Filtered, sorted, paginated list of groups.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:ListResponse"
totalResults
integer
required
startIndex
integer
itemsPerPage
integer
Resources
object[]