Class LoginPasswordlessEmailCode

constructor

• new LoginPasswordlessEmailCode(): LoginPasswordlessEmailCode

  Returns LoginPasswordlessEmailCode

screen

transaction

StaticscreenIdentifier

resendCode

• resendCode(payload?: Screens.CustomOptions): Promise<void>

  Requests a new one-time code for the user's email address.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters to send with the request.

  Returns Promise<void>

  A promise that resolves once the form is submitted, before the new page loads. It doesn't confirm that a new code was sent.

  Remarks

  Submits a form POST with action: "resend". Auth0 responds by rendering this screen again. If a captcha is required, it sends the user back to the login-id screen instead (signup-id if the user started from signup) to complete the captcha. Either way the browser loads a new page, and the current JavaScript context, including component state and timers, is lost.

  Code after await resendCode() may still run, but anything it sets up, such as a "code sent" message or a countdown, is gone after the reload. If the email can't be sent, for example because of a rate limit, Auth0 renders this screen again without an error. Only extensibility errors (such as an error from an Action) and unexpected failures appear in transaction.errors on the reloaded page. The returned promise doesn't reject.

  To add a cooldown between resends, use resendManager(). It stores its countdown in localStorage, so the countdown survives the reload.

  Example

  import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
  
  const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode();
  loginPasswordlessEmailCode.resendCode();
  Copy

resendManager

• resendManager(options?: Screens.StartResendOptions): Screens.ResendControl
  Utility Feature

  Creates a resend control manager for handling email code resend operations.

  Parameters

  • Optionaloptions: Screens.StartResendOptions

    Configuration options for the resend control

  Returns Screens.ResendControl

  A ResendControl object with resend functionality and state management

  Example

  import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
  
  const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode();
  const { startResend } = loginPasswordlessEmailCode.resendManager({
    timeoutSeconds: 60,
    onStatusChange: (remainingSeconds, isDisabled) => {
      console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
    },
    onTimeout: () => {
      console.log('Resend is now available');
    }
  });
  
  // Call startResend when user clicks resend button
  startResend();
  Copy

submitCode

• submitCode(payload: Screens.SubmitCodeOptions): Promise<void>

  Parameters

  • payload: Screens.SubmitCodeOptions

  Returns Promise<void>

  Example

  //Creates an instance of LoginPasswordlessEmailCode and calls the method with sample data.
  import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
  
  //Method to continue the login process using email and code.
  const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode();
  loginPasswordlessEmailCode.submitCode({
   email: "test@domain.com";
   code: "<string>";
  });
  Copy

switchConnection

• switchConnection(
      payload: Screens.SwitchConnectionOptionsEmailCode,
  ): Promise<void>

  Switches from passwordless email code authentication to a database connection.

  Parameters

  • payload: Screens.SwitchConnectionOptionsEmailCode

    The connection switch options

    • [key: string]: string | number | boolean

    • connection: string

  Returns Promise<void>

  Remarks

  This method allows users to switch from the current passwordless email authentication to a traditional database connection that supports username/password authentication.

  Common database connection names:

  • 'Username-Password-Authentication' - The default Auth0 database connection
  • Custom database connection names as configured in your Auth0 tenant (e.g., 'my-custom-db')

  Example

  import LoginPasswordlessEmailCode from "@auth0/auth0-acul-js/login-passwordless-email-code";
  
  const loginPasswordlessEmailCode = new LoginPasswordlessEmailCode();
  
  // Switch to the default database connection (hardcoded connection name)
  await loginPasswordlessEmailCode.switchConnection({ 
    connection: 'Username-Password-Authentication' 
  });
  
  // Or switch to a custom database connection (hardcoded connection name)
  await loginPasswordlessEmailCode.switchConnection({ 
    connection: 'my-custom-db-connection' 
  });
  Copy