EmailOTPChallenge

Describes all the properties and methods available to customize the Universal Login EmailOTPChallenge screen.

The EmailOTPChallenge class implements the email-otp-challenge screen functionality. This screen prompts the user to enter a one-time passcode sent to their email address.

Constructors

Create an instance of EmailOTPChallenge screen manager:

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.submitCode({
  code: '123456',
});

Properties

branding · BrandingMembers

Provides branding-related configurations, such as branding theme and settings.

client · ClientMembers

Provides client-related configurations, such as id, name, and logoUrl, for the email-otp-challenge screen.

organization · OrganizationMembers

Provides information about the user’s organization, such as organization id and name.

prompt · PromptMembers

Contains data about the current prompt in the authentication flow.

screen · ScreenMembers

Contains details specific to the email-otp-challenge screen, including its configuration and context.

tenant · TenantMembers

Contains data related to the tenant, such as id and associated metadata.

transaction · TransactionMembers

Provides transaction-specific data for the email-otp-challenge screen, such as active identifiers and flow states.

untrustedData · UntrustedDataMembers

Handles untrusted data passed to the SDK, such as user input during the email OTP challenge flow.

user · UserMembers

Details of the active user, including username, email, and roles.

Methods

changeLanguage · Promise<void>

This method changes the display language of the Universal Login page.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.changeLanguage({
  language: 'fr',
});

Method Parameters

Show Parameters

options · LanguageChangeOptions

language · string · required

The locale code for the desired language (for example, 'en', 'fr', 'es').

persist? · "session"

When set to 'session', the selected language persists for the duration of the session.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Additional custom fields prefixed with ulp- (for example, 'ulp-custom-field').

---

submitCode · Promise<void>

This method submits the OTP code entered by the user.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.submitCode({
  code: '123456',
});

Method Parameters

Show Parameters

options · OtpCodeOptions

code · string · required

The OTP code that the user enters to submit.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Additional data collected from the user.

---

resendCode · Promise<void>

This method requests a new OTP code to be sent to the user’s email.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
emailOTPChallenge.resendCode();

Method Parameters

Show Parameters

options · CustomOptions

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Additional data collected from the user.

---

resendManager · ResendControl

This method provides resend functionality with timeout management. It returns a ResendControl object with a startResend() method that triggers the resend and enforces a cooldown period before the user can resend again.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';

const emailOTPChallenge = new EmailOTPChallenge();
const { startResend } = emailOTPChallenge.resendManager({
  timeoutSeconds: 15,
  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();

Method Parameters

Show Parameters

options · StartResendOptions

timeoutSeconds? · number

The cooldown duration in seconds before the user can resend the code again.

onStatusChange? · OnStatusChangeCallback

Callback invoked whenever the resend status changes, it returns the remaining seconds and if the resend functionality is currently disabled.

onTimeout? · () => void

Callback invoked when the cooldown expires and resend becomes available again.

---

getErrors · Error []

This method retrieves the array of transaction errors from the context, or an empty array if none exist.