Class UsersClient

Throws

Throws

Throws

Management.ServiceUnavailableError

Throws

Example

await client.users.list({ page: 1, per_page: 1, include_totals: true, sort: "sort", connection: "connection", fields: "fields", include_fields: true, q: "q", search_engine: "v1", primary_order: true })Copy

create

create(
request: CreateUserRequestContent,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<CreateUserResponseContent>

Create a new user for a given database or passwordless connection.

Note: connection is required but other parameters such as email and password are dependent upon the type of connection.

Parameters

request: CreateUserRequestContent
OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateUserResponseContent>

Throws

Throws

Throws

Throws

Management.ConflictError

Throws

Example

await client.users.create({ connection: "connection" })Copy

listUsersByEmail

listUsersByEmail(
request: ListUsersByEmailRequestParameters,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<UserResponseSchema[]>

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

For example, if you register a user as [email protected], Auth0 saves the user's email as [email protected].

Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.

Parameters

request: ListUsersByEmailRequestParameters
OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UserResponseSchema[]>

Throws

Throws

Throws

Throws

Example

await client.users.listUsersByEmail({ fields: "fields", include_fields: true, email: "email" })Copy

get

get(
id: string,
request?: GetUserRequestParameters,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<GetUserResponseContent>

Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.

Parameters

id: string

ID of the user to retrieve.

request: GetUserRequestParameters = {}
OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetUserResponseContent>

Throws

Throws

Throws

Throws

Management.NotFoundError

Throws

Example

await client.users.get("id", { fields: "fields", include_fields: true })Copy

delete

delete(
id: string,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<void>

Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.

Parameters

id: string

ID of the user to delete.

OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

await client.users.delete("id")Copy

update

update(
id: string,
request?: UpdateUserRequestContent,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<UpdateUserResponseContent>

Update a user.

These are the attributes that can be updated at the root level:

app_metadata
blocked
email
email_verified
family_name
given_name
name
nickname
password
phone_number
phone_verified
picture
username
user_metadata
verify_email

Some considerations:

The properties of the new object will replace the old ones.
The metadata fields are an exception to this rule (user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
If you are updating email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.
If you are updating email or phone_number you can specify, optionally, the client_id property.
Updating email_verified is not supported for enterprise and passwordless sms connections.
Updating the blocked to false does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
Supported attributes can be unset by supplying null as the value.

Updating a field (non-metadata property)

To mark the email address of a user as verified, the body to send should be:

{ "email_verified": true }

Updating a user metadata root property

Let's assume that our test user has the following user_metadata:

{ "user_metadata" : { "profileCode": 1479 } }

To add the field addresses the body to send should be:

{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}

The modified object ends up with the following user_metadata property:

{
"user_metadata": {
"profileCode": 1479,
"addresses": { "work_address": "100 Industrial Way" }
}
}

Updating an inner user metadata property

If there's existing user metadata to which we want to add "home_address": "742 Evergreen Terrace" (using the addresses property) we should send the whole addresses object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:

{
  "user_metadata": {
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

The modified object ends up with the following user_metadata property:

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

Parameters

id: string

ID of the user to update.

request: UpdateUserRequestContent = {}
OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateUserResponseContent>

Throws

Throws

Throws

Throws

Management.NotFoundError

Throws

Example

await client.users.update("id")Copy

regenerateRecoveryCode

regenerateRecoveryCode(
id: string,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<RegenerateUsersRecoveryCodeResponseContent>

Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.

Parameters

id: string

ID of the user to regenerate a multi-factor authentication recovery code for.

OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<RegenerateUsersRecoveryCodeResponseContent>

Throws

Throws

Throws

Throws

Management.NotFoundError

Example

await client.users.regenerateRecoveryCode("id")Copy

revokeAccess

revokeAccess(
id: string,
request?: RevokeUserAccessRequestContent,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<void>

Revokes selected resources related to a user (sessions, refresh tokens, ...).

Parameters

id: string

ID of the user.

request: RevokeUserAccessRequestContent = {}
OptionalrequestOptions: UsersClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws