Interface UserUpdate

Hierarchy

  • UserUpdate

Indexable

[key: string]: any | any

Properties

app_metadata? blocked? client_id? connection? email? email_verified? family_name? given_name? name? nickname? password? phone_number? phone_verified? picture? user_metadata? username? verify_email? verify_phone_number?

Properties

Optional app_metadata

app_metadata?: null | UserUpdateAppMetadata

Optional blocked

blocked?: boolean

Whether this user was blocked by an administrator (true) or not (false).

Optional client_id

client_id?: string

Auth0 client ID. Only valid when updating email address.

Optional connection

connection?: string

ID of the connection this user should be created in.

Optional email

email?: string

Email address of this user.

Optional email_verified

email_verified?: boolean

Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless verify_email is set to true.

Optional family_name

family_name?: null | string

Family name/last name/surname of this user.

Optional given_name

given_name?: null | string

Given name/first name/forename of this user.

Optional name

name?: null | string

Name of this user.

Optional nickname

nickname?: null | string

Preferred nickname or alias of this user.

Optional password

password?: string

New password for this user (mandatory for non-SMS connections).

Optional phone_number

phone_number?: string

The user's phone number (following the E.164 recommendation), only valid for users from SMS connections.

Optional phone_verified

phone_verified?: boolean

Whether this phone number has been verified (true) or not (false).

Optional picture

picture?: null | string

URL to picture, photo, or avatar of this user.

Optional user_metadata

user_metadata?: null | {
    [key: string]: any;
}

User metadata to which this user has read/write access.

Optional username

username?: string

The user's username. Only valid if the connection requires a username.

Optional verify_email

verify_email?: boolean

Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of email_verified parameter.

Optional verify_phone_number

verify_phone_number?: boolean

Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number.

Settings

Member Visibility

Theme

On This Page