MfaBeginEnrollOptions

The MfaBeginEnrollOptions class implements the mfa-begin-enroll-options screen functionality. This screen handles the selection and enrollment of MFA factors. ​

Constructors

Create an instance of MFA Begin Enroll Options screen manager

Example

import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options';
const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

Properties

branding

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

client

Provides client-related configurations, such as id, name, and logoUrl.

organization

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

prompt

Contains data about the current prompt in the authentication flow.

screen

Contains details specific to the screen, including its configuration and context.

tenant

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

transaction

Provides transaction-specific data, such as active identifiers and flow states.

untrustedData

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

user

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

Methods

enroll · (options ?)

This method continues the enrollment process with the selected factor.

Example

const mfaBeginEnrollOptions = new MfaBeginEnrollOptions();
await mfaBeginEnrollOptions.enroll({
  action: 'push-notification'
});

options · OPTIONAL

The enrollment options including the selected factor.

Show options properties

action · "push-notification" | "otp" | "sms" | "phone" | "voice" | "webauthn-roaming" · required

The action indicating which factor to enroll.

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

Additional data collected from the user.

getErrors

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