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

    Interface PasswordlessStartEmailOptions

    Options to start a passwordless flow via email. Auth0 will send a magic link or OTP code to the provided email address.

    interface PasswordlessStartEmailOptions {
        authParams?: Record<string, string>;
        connection: "email";
        email: string;
        language?: string;
        send: "code" | "link";
    }
    Index

    Properties

    authParams? connection email language? send

    Properties

    authParams?: Record<string, string>

    Additional authentication parameters passed to Auth0 in the authParams body field of /passwordless/start. Useful for magic-link flows where you need to set redirect_uri, scope, or custom parameters.

    await auth0.passwordless.start({
      connection: 'email',
      email: 'user@example.com',
      send: 'link',
      authParams: { redirect_uri: 'https://example.com/callback', scope: 'openid profile' }
    });
    connection: "email"

    The passwordless connection to use.

    email: string

    The email address to send the code or link to.

    language?: string

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

    send: "code" | "link"

    The type of credential to deliver.

    • 'code' — one-time password (OTP)
    • 'link' — magic link

    Settings

    Member Visibility

    On This Page

    Properties