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 ResetPasswordMfaWebAuthnPlatformChallenge class implements the reset-password-mfa-webauthn-platform-challenge screen functionality. This screen prompts the user to verify their identity using a platform authenticator (such as Touch ID or Windows Hello) as part of the MFA step during a password reset flow.

Constructors

Create an instance of ResetPasswordMfaWebAuthnPlatformChallenge screen manager:
Example
import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.continueWithPasskey({
  rememberDevice: true,
});

Properties

Provides branding-related configurations, such as branding theme and settings.
Provides client-related configurations, such as id, name, and logoUrl, for the reset-password-mfa-webauthn-platform-challenge screen.
Provides information about the user’s Organization, such as id and name.
Contains data about the current prompt in the authentication flow.
Contains details specific to the reset-password-mfa-webauthn-platform-challenge screen, including its configuration and context.
Contains data related to the tenant, such as id and associated metadata.
Provides transaction-specific data for the reset-password-mfa-webauthn-platform-challenge screen, such as active identifiers and flow states.
Handles untrusted data passed to the SDK, such as user input during the MFA challenge flow.
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 ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
resetPasswordMfaWebAuthnPlatformChallengeManager.changeLanguage({
  language: 'fr',
});
Method Parameters

continueWithPasskey
Promise<void>
This method initiates the WebAuthn platform authenticator challenge and submits the resulting credential to complete the MFA step during the password reset flow. If the browser throws a DOMException (such as user cancellation), catch the error and call reportBrowserError to notify Auth0.
Example
import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
try {
  await resetPasswordMfaWebAuthnPlatformChallengeManager.continueWithPasskey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnPlatformChallengeManager.reportBrowserError({
      error: { name: error.name, message: error.message },
    });
  }
}
Method Parameters

getErrors
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
reportBrowserError
Promise<void>
This method reports a browser-side WebAuthn error to Auth0, such as user cancellation (NotAllowedError) or a timeout from navigator.credentials.get().
Example
import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.reportBrowserError({
  error: { name: error.name, message: error.message },
});
Method Parameters

tryAnotherMethod
Promise<void>
This method allows the user to select a different MFA method to complete the challenge.
Example
import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.tryAnotherMethod();
Method Parameters