Search users

POST/v1/users/search

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

Roles

adminissuermanaged-issuer

Analytics Events

USER_SEARCH_STARTUSER_SEARCH_SUCCESSUSER_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`

curl -X POST "https://example.com/v1/users/search" \  -H "Content-Type: application/json" \  -d '{}'

{  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",  "data": [    {      "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",      "claims": {        "externalUserId": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba"      },      "authenticationProvider": {        "providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",        "url": "https://example-university.au.auth0.com",        "subjectId": "example-university-oauth2|123456789"      }    }  ]}

POST/v1/users/search

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

Roles

adminissuermanaged-issuer

Analytics Events

USER_SEARCH_STARTUSER_SEARCH_SUCCESSUSER_SEARCH_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The search criteria

TypeScript Definitions

Use the request body type in TypeScript.

claims?

Filter users by claims. Nested objects are supported. Text values must be an exact match.

authenticationProvider?

Filter users by their unique identifier in the configured Authentication Provider.

limit?number

Range size of returned entries, default 100

Range1 <= value <= 1000

cursor?string

Starting point for the range of entries

Response Body

`application/json`

curl -X POST "https://example.com/v1/users/search" \  -H "Content-Type: application/json" \  -d '{}'

{  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",  "data": [    {      "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",      "claims": {        "externalUserId": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba"      },      "authenticationProvider": {        "providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",        "url": "https://example-university.au.auth0.com",        "subjectId": "example-university-oauth2|123456789"      }    }  ]}

Roles

Analytics Events

Authorization

Request Body

Response Body

200application/json

400application/json

Search users

Roles

Analytics Events

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`