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 MfaPushEnrollmentQr class implements the mfa-push-enrollment-qr screen functionality.
ACUL MFA Push Enrollment QR

​
Constructors

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

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();

​
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-push-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
ScreenMembersOnMfaPushEnrollmentQr
Contains details specific to the mfa-push-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-push-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 push 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 MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';
const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
mfaPushEnrollmentQr.changeLanguage({
  language: 'fr',
});
Method Parameters
​
continue
Promise<void>
This method proceeds with the push notification enrollment.
Example
import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.continue();
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
pickAuthenticator
Promise<void>
This method navigates to the authenticator selection screen.
Example
import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();
await mfaPushEnrollmentQr.pickAuthenticator();
Method Parameters
​
pollingManager
MfaPushPollingControl
This method starts and manages polling for an MFA push enrollment.Creates a polling session that repeatedly checks the MFA push enrollment endpoint at the specified interval until the enrollment is approved or an error occurs. When the approval condition is met, the provided onCompleted callback is invoked and polling stops automatically.Use the returned MfaPushPollingControl to start, stop, or check the status of the polling process at any time.Returns an MfaPushPollingControl instance exposing:
  • startPolling() — Starts or resumes polling.
  • stopPolling() — Cancels polling immediately.
  • isRunning() — Indicates whether polling is currently active.
Example
import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr';

const mfaPushEnrollmentQr = new MfaPushEnrollmentQr();

// Start polling every 5 seconds until the push enrollment is approved
const control = mfaPushEnrollmentQr.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushEnrollmentQr.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// Later, cancel polling if needed
control.stopPolling();
Remarks
  • HTTP 429 (rate limit) responses are handled internally: polling automatically waits until the rate limit resets before retrying.
  • Safe to call startPolling() multiple times; it has no effect if already running.
Method Parameters