MfaSmsChallenge

This class provides methods to handle the mfa-sms-challenge screen.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

Constructors

MfaSmsChallenge · Constructor

Creates an instance of MfaSmsChallenge screen manager

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

continueMfaSmsChallenge · Promise<void>

Submits the MFA SMS challenge with the provided code and rememberDevice option.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

Show Parameters

payload

Properties

code · string

rememberDevice? · boolean

getACall · Promise<void>

Submits the action to switch to voice call verification.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.getACall();

Show Parameters

payload?

Optional payload.

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.

pickSms · Promise<void>

Submits the action to pick a different SMS configuration, if available.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.pickSms();

Show Parameters

payload?

Optional payload.

resendCode · Promise<void>

Submits the action to resend the SMS code.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.resendCode();

Show Parameters

payload?

Optional payload.

resendManager

Utility Feature

Gets resend functionality with timeout management for this screen

ResendControl object with startResend method

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

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

Submits the action to try another MFA method.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.tryAnotherMethod();

Show Parameters

payload?

Optional payload.