v2
OpenAPI 3.0.02026-08-051996591.2 MBUsers
List users
Lists all users in the customer account. The response shows each user's corpus access and customer-level authorizations.
To enable, disable, or edit the roles of a user, use the Update User endpoint.
get/v2/users
Query parameters
limitinteger
The maximum number of users to return at one time.
page_keystring
The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.
corpus_keystring
A user-provided key for a corpus.
Example:my-corpus
Filter users by access to this corpus.
Headers
Request-Timeoutinteger
The platform makes a best effort to complete the request in the specified seconds, or it times out.
Request-Timeout-Millisinteger
The platform makes a best effort to complete the request in the specified milliseconds, or it times out.
Response
List of users.
Example response
{
"metadata": {
"page_key": "eyJvZmZzZXQiOjF9"
}
}