MfaSmsEnrollment

Represents the MFA SMS Enrollment screen.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.pickCountryCode();

Constructors

MfaSmsEnrollment · Constructor

Initializes a new instance of the MfaSmsEnrollment class.

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

continueEnrollment · Promise<void>

Continues the SMS enrollment process with the provided phone number.

A promise that resolves when the enrollment process is complete.

Throws

If the phone number is missing.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

Show Parameters

payload

Properties

captcha? · string

phone? · string

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.

pickCountryCode · Promise<void>

Handles the action to pick a country code for SMS enrollment.

A promise that resolves when the action is complete.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.pickCountryCode();

Show Parameters

payload?

Optional custom options to include in the request.

tryAnotherMethod · Promise<void>

Handles the action to try another method for MFA.

A promise that resolves when the action is complete.

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.tryAnotherMethod();

Show Parameters

payload?

Optional custom options to include in the request.