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 ResetPasswordMfaWebAuthnRoamingChallenge class implements the reset-password-mfa-webauthn-roaming-challenge screen functionality. This screen prompts the user to verify their identity using a roaming security key (such as a FIDO2 USB key) as part of the MFA step during a password reset flow.

​
Constructors

Create an instance of ResetPasswordMfaWebAuthnRoamingChallenge screen manager:
Example
import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}

​
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 reset-password-mfa-webauthn-roaming-challenge 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
ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge
Contains details specific to the reset-password-mfa-webauthn-roaming-challenge 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 reset-password-mfa-webauthn-roaming-challenge screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during the MFA challenge flow.
​
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 ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
resetPasswordMfaWebAuthnRoamingChallengeManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
showError
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 ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
  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 ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.tryAnotherMethod();
Method Parameters
​
useSecurityKey
Promise<void>
This method initiates the WebAuthn security key 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 showError to notify Auth0.
Example
import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}
Method Parameters