MfaEmailChallenge

Class implementing the mfa-email-challenge screen functionality This screen is shown when a user needs to verify their email during MFA

Example

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

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

Constructors

MfaEmailChallenge · Constructor

Creates an instance of MfaEmailChallenge screen manager

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

continue · Promise<void>

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
});

Show Parameters

payload

Properties

code · string

rememberDevice? · boolean

getErrors

Retrieves the array of transaction errors from the context, or an empty array if none exist.

An array of error objects from the transaction context.

pickEmail · Promise<void>

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();

Show Parameters

payload?

Optional payload.

resendCode · Promise<void>

Resends the email code

Example

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

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

Show Parameters

payload?

Optional custom options to include with the request

resendManager

Utility Feature

Gets resend functionality with timeout management for this screen

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();

Show Parameters

options?

Configuration options for resend functionality

Properties

onStatusChange?

onTimeout · void

timeoutSeconds? · number

tryAnotherMethod · Promise<void>

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();

Show Parameters

payload?

Optional custom options to include with the request