Sign in
User

Search

Search users based on filters specified in the request body.

post/api/v1/search/users

Request body

emailstring

Search for users based on their email (exact match).

excludeIdsstring[] nullable

An array of users IDs to exclude from the results.

excludeTypesstring[] nullable

An array of types to exclude from the results.

idsstring[] nullable

Deprecated. Use refs array instead.

pageSizeinteger

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageTokenstring

The pageToken field.

querystring

Query the apps with a fuzzy search on display name and emails.

roleIdsstring[] nullable

Search for users that have any of the role IDs on this list.

userStatusesstring[] nullable

Search for users that have any of the statuses on this list. This can only be ENABLED, DISABLED, and DELETED

Response

Successful response

nextPageTokenstring

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Changes