@faable/auth-js - v3.1.0
    Preparing search index...

    Type Alias SignupParams

    The new user for FaableAuthClient.signup. Which identifier is required follows the database connection's login identifier: an email connection needs email, a username one needs username, and email_or_username accepts either (or both).

    type SignupParams = {
        connection?: string;
        email?: string;
        family_name?: string;
        given_name?: string;
        name?: string;
        password?: string;
        user_metadata?: Record<string, unknown>;
        username?: string;
    }
    Index

    Properties

    connection? email? family_name? given_name? name? password? user_metadata? username?

    Properties

    connection?: string

    Database connection name, when the tenant has more than one.

    email?: string

    Email identifier. Required unless the connection signs in by username, and whenever password is omitted.

    family_name?: string
    given_name?: string
    name?: string
    password?: string

    Checked against the connection's password policy. Omit it to create the user without one: they set it through the password reset email, and until then nothing signs in with a password.

    user_metadata?: Record<string, unknown>
    username?: string

    Username identifier, stored as typed (case-sensitive). No @ or whitespace.

    Settings

    Member Visibility

    On This Page

    Properties