Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

Lists the users in your account along with their corpus access and customer-level authorizations. Some tips for this API:

  • This operation only works with OAuth 2.0 (in a JWT "Bearer Token") authentication. It does not work with API Keys. You can find details of how to set up and use OAuth 2.0 here.
  • Use this API to view the members on your team. If you need to manage their access, use the Manage User endpoint.
post/v1/list-users

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

listUsersType'LIST_USERS_TYPE__NONE' | 'LIST_USERS_TYPE__CUSTOMER' | 'LIST_USERS_TYPE__ALL'
pageKeystring byte

A key that is passed to retrieve a specific page of results. Leave empty to retrieve first page. Subsequent page requests should use the page key returned in previous response, and all other fields are ignored.

numResultsinteger

Number of results to return.

Response

A successful response.

pageKeystring byte

A key that is passed into a subsequent result in order to retrieve the next page of results.