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 MfaOtpEnrollmentQr class implements the mfa-otp-enrollment-qr screen functionality. This screen displays a QR code for the user to scan with their authenticator app during MFA enrollment.
ACUL MFA OTP Enrollment QR

​
Constructors

Create an instance of MFA OTP Enrollment QR screen manager:
Example
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

​
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-otp-enrollment-qr 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
ScreenMembersOnMfaOtpEnrollmentQr
Contains details specific to the mfa-otp-enrollment-qr 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-otp-enrollment-qr screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during MFA OTP 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 MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
mfaOtpEnrollmentQr.changeLanguage({
  language: 'fr',
});
Method Parameters
​
continue
Promise<void>
This method submits the OTP code to continue the enrollment process.
Example
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.continue({ code: '123456' });
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
toggleView
Promise<void>
This method switches between QR code and manual entry views.
Example
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

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

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.tryAnotherMethod();
Method Parameters