@auth0/nextjs-auth0 - v4.21.0
    Preparing search index...

    Interface PasswordlessStartSmsOptions

    Options to start a passwordless flow via SMS. Auth0 will send an OTP to the provided phone number.

    interface PasswordlessStartSmsOptions {
        authParams?: Record<string, string>;
        connection: "sms";
        language?: string;
        phoneNumber: string;
    }
    Index

    Properties

    authParams? connection language? phoneNumber

    Properties

    authParams?: Record<string, string>

    Additional authentication parameters passed to Auth0 in the authParams body field of /passwordless/start.

    connection: "sms"

    The passwordless connection to use.

    language?: string

    BCP 47 language tag (e.g. 'en', 'fr', 'pt-BR') forwarded as x-request-language to Auth0. Used to select the correct SMS template language when multiple are configured on the connection.

    phoneNumber: string

    The phone number to send the OTP to, in E.164 format (e.g. '+14155550100').

    Settings

    Member Visibility

    On This Page

    Properties