light-mode-image
Learn
API ReferenceUsers

Search users

Roles

adminissuermanaged-issuer

Analytics Events

USER_SEARCH_STARTUSER_SEARCH_SUCCESSUSER_SEARCH_FAIL
POST/v1/users/search

Returns a list of users from the tenant that match all the provided search criteria (all criteria are optional).

Analytic events

  • USER_SEARCH_START
  • USER_SEARCH_SUCCESS
  • USER_SEARCH_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

The search criteria

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/users/search" \  -H "Content-Type: application/json" \  -d '{}'
{  "nextCursor": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "claims": {},      "authenticationProvider": {        "providerId": "string",        "url": "string",        "subjectId": "string"      }    }  ]}

How would you rate this page?

Delete a user DELETE

Deletes a user and removes all data related to them by providing the user ID. <Callout type="warning"> Deleting a user is irreversible. All of the user's data is removed, and any credential previously issued to them is no longer valid. </Callout> ### **Analytic events** * USER_DELETE_START * USER_DELETE_SUCCESS * USER_DELETE_FAIL

Retrieve all user credentials data GET

Returns metadata for all the credentials issued to the provided `userId`. ### **Analytic events** * USER_CREDENTIAL_RETRIEVE_LIST_START * USER_CREDENTIAL_RETRIEVE_LIST_SUCCESS * USER_CREDENTIAL_RETRIEVE_LIST_FAIL