Skip to main content
The mfa-webauthn-error screen displays an error that occurred during a WebAuthn authentication attempt and provides options for the user to recover or try a different method.
MFAWebauthnError

Import

Each screen has its own set of hooks and methods. The SDK supports partial import and root import for each screen.
  • Using partial import allows you include only the code you need for your specific use case.
  • Using root import allows you to load all screens from a single bundle useful when you want a unified build to handle all possible screens.
Import Example
// root import
import { useMfaWebAuthnError } from '@auth0/auth0-acul-react';

// partial import
import {
  useMfaWebAuthnError,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  noThanks,
  tryAgain,
  tryAnotherMethod,
  usePassword,
} from "@auth0/auth0-acul-react/mfa-webauthn-error";

function MfaWebAuthnErrorScreen() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Try Again
    </button>
  );
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the mfa-webauthn-error screen. Import them from @auth0/auth0-acul-react/mfa-webauthn-error.
useBranding
This hook provides branding configurations, such as logo, colors, and theme settings displayed on the mfa-webauthn-error screen.
Example
import { useBranding } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function CustomTheme() {
  const branding = useBranding();
}
useClient
This hook provides client-related configurations, such as id, name, and logoUrl, for the mfa-webauthn-error screen.
Example
import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function AppInfo() {
  const client = useClient();
}
useOrganization
This hook provides information about the user’s Organization if the MFA flow is Organization scoped. Returns null when no Organization context is present.
Example
import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}
usePrompt
This hook contains data about the current prompt in the authentication flow.
Example
import { usePrompt } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function FlowInfo() {
  const prompt = usePrompt();
}
This hook contains details specific to the mfa-webauthn-error screen, including its configuration and context.
Example
import { useScreen } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function ScreenDebug() {
  const screen = useScreen();
}
useTenant
This hook contains data related to the tenant, such as id and associated metadata.
Example
import { useTenant } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function TenantInfo() {
  const tenant = useTenant();
}
useTransaction
This hook provides transaction-specific data for the mfa-webauthn-error screen, such as the current MFA flow state.
Example
import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function TransactionInfo() {
  const transaction = useTransaction();
}
useUntrustedData
This hook handles untrusted data passed to the screen, such as prefilled values from URL parameters.
Example
import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
useUser
This hook provides details of the active user, including username, email, and available authentication methods.
Example
import { useUser } from '@auth0/auth0-acul-react/mfa-webauthn-error';
function UserProfile() {
  const user = useUser();
}
useMfaWebAuthnError
This hook returns all methods and context available on the mfa-webauthn-error screen.

Methods

noThanks
void | Promise<void>
This method dismisses the WebAuthn error and cancels the current MFA flow.
Example
import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function NoThanksButton() {
  const { noThanks } = useMfaWebAuthnError();
  return (
    <button onClick={() => noThanks()}>
      No Thanks
    </button>
  );
}
tryAgain
void | Promise<void>
This method retries the WebAuthn authentication after an error.
Example
import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function TryAgainButton() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Try Again
    </button>
  );
}
tryAnotherMethod
void | Promise<void>
This method navigates to the MFA method selection screen so the user can choose a different authentication factor.
Example
import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}
usePassword
void | Promise<void>
This method switches the authentication flow to use a password instead of WebAuthn.
Example
import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function UsePasswordButton() {
  const { usePassword } = useMfaWebAuthnError();
  return (
    <button onClick={() => usePassword()}>
      Use Password Instead
    </button>
  );
}

Common/Utility Hooks

This hook gets the current theme options with flattened configuration from branding context.
This hook returns a function for changing the display language on the current ACUL screen.
This hook gets the current screen context and state.
This hook reads and manages server, client, and developer errors on the screen.