Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-fix-auth-api-docs-migration-completion.mintlify.app/llms.txt

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

The MfaPushChallengePush class implements the mfa-push-challenge-push screen functionality. This screen is shown when a user needs to confirm a push notification during MFA.
ACUL MFA Push Challenge Push

​
Constructors

Create an instance of MFA Push Challenge Push screen manager:
Example
import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();

​
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-challenge-push 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
ScreenMembersOnMfaPushChallengePush
Contains details specific to the mfa-push-challenge-push 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-challenge-push screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembersOnMfaPushChallengePush
Handles untrusted data passed to the SDK, such as user input during MFA push challenge.
​
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 MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';
const mfaPushChallengePush = new MfaPushChallengePush();
mfaPushChallengePush.changeLanguage({
  language: 'fr',
});
Method Parameters
​
continue
Promise<void>
This method continues with the push notification challenge.
Example
import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.continue();
Method Parameters
​
enterCodeManually
Promise<void>
This method switches to entering the verification code manually.
Example
import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.enterCodeManually();
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
pollingManager
MfaPushPollingControl
This method starts and manages polling for an MFA push challenge.Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge 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 MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();

// Start polling every 5 seconds until the push challenge is approved
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.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
​
resendPushNotification
Promise<void>
This method resends the push notification.
Example
import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.resendPushNotification();
Method Parameters
​
tryAnotherMethod
Promise<void>
This method allows the user to try another MFA method.
Example
import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push';

const mfaPushChallengePush = new MfaPushChallengePush();
await mfaPushChallengePush.tryAnotherMethod();
Method Parameters