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

    Interface SignUpRequest

    interface SignUpRequest {
        client_id?: string;
        email: string;
        password: string;
        connection: string;
        username?: string;
        given_name?: string;
        family_name?: string;
        name?: string;
        nickname?: string;
        picture?: string;
        user_metadata?: { [key: string]: unknown };
    }
    Index

    Properties

    client_id? email password connection username? given_name? family_name? name? nickname? picture? user_metadata?

    Properties

    client_id?: string

    The client_id of your client. Use if you want to override the class's clientId

    email: string

    The user's email address.

    password: string

    The user's desired password.

    connection: string

    The name of the database configured to your client.

    username?: string

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

    given_name?: string

    The user's given name(s).

    family_name?: string

    The user's family name(s).

    name?: string

    The user's full name.

    nickname?: string

    The user's nickname.

    picture?: string

    A URI pointing to the user's picture.

    user_metadata?: { [key: string]: unknown }

    The user metadata to be associated with the user. If set, the field must be an object containing no more than ten properties. Property names can have a maximum of 100 characters, and property values must be strings of no more than 500 characters.

    Settings

    Member Visibility

    On This Page

    Properties