v1
latestOpenAPI 3.0.32026-07-17174981.5 KBUsers Endpoint
Filter Users
This API returns users according to the filter, sort and pagination parameters. Pagination is not supported across user stores and LDAP multi-attribute group filtering. However, filtering is supported across multiple user stores.
-
<b>Scope(Permission) required:</b> internal_user_mgt_list
-
<b>Flow type:</b> Client Credentials OAuth Flow
get/Users
Query parameters
attributesstring
SCIM defined attributes parameter.
excludedAttributesstring
SCIM defined excludedAttribute parameter.
filterstring
The expression used for filtering. Supported filters are ‘Ew’, ‘Eq’, ‘Co’, ‘Sw’, ‘Ne’ and ‘and’.
startIndexinteger
The 1-based index of the first query result
countinteger
Specifies the desired maximum number of query results per page.
domainstring
The name of the user store where filtering needs to be applied.
Response
Valid users are found / Valid users are not found