Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0.com/llms.txt

Use this file to discover all available pages before exploring further.

The MfaPhoneEnrollment class implements the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA.
ACUL MFA Phone Enrollment

​
Constructors

Create an instance of MFA Phone Enrollment screen manager:
Example
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '+1234567890', type: 'sms' });

​
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, for the mfa-phone-enrollment screen.
​
organization
OrganizationMembers
Provides information about the user’s Organization, such as id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembers
Contains details specific to the mfa-phone-enrollment 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 for the mfa-phone-enrollment screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during MFA phone enrollment.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollment = new MfaPhoneEnrollment();
mfaPhoneEnrollment.changeLanguage({
  language: 'fr',
});
Method Parameters
​
continueEnrollment
Promise<void>
This method continues the enrollment process with the provided phone number and type (SMS or voice).
Example
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.continueEnrollment({ phone: '+1234567890', type: 'sms' });
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
pickCountryCode
Promise<void>
This method navigates to the country code selection screen.
Example
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.pickCountryCode();
Method Parameters
​
tryAnotherMethod
Promise<void>
This method allows the user to try another MFA method.
Example
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';

const mfaPhoneEnrollment = new MfaPhoneEnrollment();
await mfaPhoneEnrollment.tryAnotherMethod();
Method Parameters