MfaEmailChallenge

The MfaEmailChallenge class implements the mfa-email-challenge screen functionality. This screen is shown when a user needs to verify their email during MFA.

Constructors

Create an instance of MfaCountryCodes screen

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

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.

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 · ScreenMembersOnMfaEmailChallenge

Contains details specific to the mfa-email-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, such as active identifiers and flow states.

untrustedData · UntrustedDataMembersOnMfaEmailChallenge

Handles untrusted data passed to the SDK, such as user input during login.

user · UserMembers

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

Methods

continue · (options ?)

This method continues with the email challenge using the provided code.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

options · OPTIONAL

The options for continuing with the email challenge.

Show options properties

code · string · required

The code entered by the user.

rememberDevice? · boolean

Indicates whether to remember the device.

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

Additional data collected from the user.

getErrors · Error []

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

pickEmail · (options ?)

This method submits the action to pick a different Email configuration, if available.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.pickEmail();

options · OPTIONAL

Optional payload.

Show options properties

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

Additional data collected from the user.

resendCode · (options ?)

This method resends the email code.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.resendCode();

options · OPTIONAL

Optional custom options to include with the request

Show options properties

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

Additional data collected from the user.

resendManager · ResendControl

This method resends functionality with timeout management for this screen. A ResendControl object with startResend method.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
const { startResend } = mfaEmailChallenge.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();

options · OPTIONAL

Optional custom options to include with the request.

Show options properties

onStatusChange? · OnStatusChangeCallback

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

onTimeout · void

timeoutSeconds? · number

tryAnotherMethod · (options ?)

This method allows the user to try another MFA method.

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.tryAnotherMethod();

options · OPTIONAL

Optional custom options to include with the request.

Show options properties

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

Any additional custom options.