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

    Class Passwordless

    Handles passwordless flows using Email and SMS.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Start passwordless flow sending an email.

      Given the user email address, it will send an email with:

      • A link (default, `send:"link"`). You can then authenticate with this user opening the link and he will be automatically logged in to the application. Optionally, you can append/override parameters to the link (like `scope`, `redirect_uri`, `protocol`, `response_type`, etc.) using `authParams` object.
      • A verification code (`send:"code"`). You can then authenticate with this user using the `/oauth/token` endpoint specifying `email` as `username` and `code` as `password`.

      See: https://auth0.com/docs/api/authentication#get-code-or-link

      Parameters

      Returns Promise<VoidApiResponse>

      const auth0 = new AuthenticationApi({
      domain: 'my-domain.auth0.com',
      clientId: 'myClientId',
      clientSecret: 'myClientSecret'
      });

      await auth0.passwordless.sendEmail({
      email: '{EMAIL}',
      send: 'link',
      authParams: {} // Optional auth params.
      });
    • Start passwordless flow sending an SMS.

      Given the user phone_number, it will send a SMS message with a verification code. You can then authenticate with this user using the /oauth/token endpoint specifying phone_number as username and code as password:

      See: https://auth0.com/docs/api/authentication#get-code-or-link

      Parameters

      Returns Promise<VoidApiResponse>

      const auth0 = new AuthenticationApi({
      domain: 'my-domain.auth0.com',
      clientId: 'myClientId',
      clientSecret: 'myClientSecret'
      });

      await auth0.passwordless.sendSMS({
      phone_number: '{PHONE}'
      });
    • Once you have a verification code, use this endpoint to login the user with their email and verification code.

      Parameters

      Returns Promise<JSONApiResponse<TokenSet>>

      const auth0 = new AuthenticationApi({
      domain: 'my-domain.auth0.com',
      clientId: 'myClientId',
      clientSecret: 'myClientSecret'
      });

      await auth0.passwordless.loginWithEmail({
      email: 'foo@example.com',
      code: 'ABC123'
      });
    • Once you have a verification code, use this endpoint to login the user with their phone number and verification code.

      Parameters

      Returns Promise<JSONApiResponse<TokenSet>>

      const auth0 = new AuthenticationApi({
      domain: 'my-domain.auth0.com',
      clientId: 'myClientId',
      clientSecret: 'myClientSecret'
      });

      await auth0.passwordless.loginWithSMS({
      phone_number: '0777777777',
      code: 'ABC123'
      });

    Properties

    domain: string
    clientId: string
    clientSecret?: string
    clientAssertionSigningKey?: string
    clientAssertionSigningAlg?: string
    useMTLS?: boolean
    configuration: Configuration