v1

latestOpenAPI 3.1.02026-07-268342124.0 KB

users

Update user

Update information about a user. Any fields which are omitted in the request will be left unchanged.

patch/users/{userId}

Path parameters

userIdstring required

The ID of the user.

Request body

customobject

A JSON object which can include any key/value pairs. Should be provided when using rules based on your own data points.

usernamestring

The username used as the primary identifier for passkeys, e.g. an email address.

displayNamestring

The display name used as an optional secondary identifier for passkeys, e.g. the user's full name.

emailstring

The user's email address.

emailVerifiedboolean

Set this to true if the user's email address has already been verified in your own system. This will result in any email OTP or magic link authenticators being updated to reflect the new email address, and the next email challenge will be sent to the new email address.

phoneNumberstring

The user's phone number in E.164 format.

phoneNumberVerifiedboolean

Set this to true if the user's phone number has already been verified in your own system. This will result in any SMS authenticators being updated to reflect the new number and the next SMS challenge will be sent to the new phone number.

localestring

The locale of the user in BCP 47 format. Used to localize the pre-built UI, email, and SMS messages.

Example request

{
  "locale": "es"
}

Response

userIdstring

The user's ID.