Auth0 Node.js SDK - v5.0.0
    Preparing search index...

    Interface UpdateUserRequestContent

    {}
    interface UpdateUserRequestContent {
        blocked?: boolean;
        email_verified?: boolean;
        email?: string;
        phone_number?: string;
        phone_verified?: boolean;
        user_metadata?: UserMetadata;
        app_metadata?: AppMetadata;
        given_name?: string;
        family_name?: string;
        name?: string;
        nickname?: string;
        picture?: string;
        verify_email?: boolean;
        verify_phone_number?: boolean;
        password?: string;
        connection?: string;
        client_id?: string;
        username?: string;
    }
    Index

    Properties

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

    Properties

    blocked?: boolean

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

    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.

    email?: string

    Email address of this user.

    phone_number?: string

    The user's phone number (following the E.164 recommendation).

    phone_verified?: boolean

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

    user_metadata?: UserMetadata
    app_metadata?: AppMetadata
    given_name?: string

    Given name/first name/forename of this user.

    family_name?: string

    Family name/last name/surname of this user.

    name?: string

    Name of this user.

    nickname?: string

    Preferred nickname or alias of this user.

    picture?: string

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

    verify_email?: boolean

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

    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 for SMS connections.

    password?: string

    New password for this user. Only valid for database connections.

    connection?: string

    Name of the connection to target for this user update.

    client_id?: string

    Auth0 client ID. Only valid when updating email address.

    username?: string

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

    Settings

    Member Visibility

    On This Page

    Properties