Skip to main content
The mfa-webauthn-platform-enrollment screen prompts the user to enroll a platform authenticator, such as Touch ID or Windows Hello, as an MFA factor.
MfaWebAuthnPlatformEnrollment

​
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 { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react';

// partial import
import {
  useMfaWebAuthnPlatformEnrollment,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  refuseEnrollmentOnThisDevice,
  reportBrowserError,
  snoozeEnrollment,
  submitPasskeyCredential,
} from "@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment";

function MfaWebAuthnPlatformEnrollmentScreen() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​
Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the mfa-webauthn-platform-enrollment screen. Import them from @auth0/auth0-acul-react/mfa-webauthn-platform-enrollment.
​
useBranding
() => BrandingMembers
This hook provides branding configurations, such as logo, colors, and theme settings displayed on the mfa-webauthn-platform-enrollment screen.
Example
import { useBranding } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function CustomTheme() {
  const branding = useBranding();
}
​
useClient
() => ClientMembers
This hook provides client-related configurations, such as id, name, and logoUrl, for the mfa-webauthn-platform-enrollment screen.
Example
import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function AppInfo() {
  const client = useClient();
}
​
useOrganization
() => OrganizationMembers
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-platform-enrollment';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}
​
usePrompt
() => PromptMembers
This hook contains data about the current prompt in the authentication flow.
Example
import { usePrompt } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function FlowInfo() {
  const prompt = usePrompt();
}
​
useScreen
() => ScreenMembersOnMfaWebAuthnPlatformEnrollment
This hook contains details specific to the mfa-webauthn-platform-enrollment screen, including its configuration and context.
Example
import { useScreen } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function ScreenDebug() {
  const screen = useScreen();
}
​
useTenant
() => TenantMembers
This hook contains data related to the tenant, such as id and associated metadata.
Example
import { useTenant } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function TenantInfo() {
  const tenant = useTenant();
}
​
useTransaction
() => TransactionMembers
This hook provides transaction-specific data for the mfa-webauthn-platform-enrollment screen, such as the current MFA flow state.
Example
import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function TransactionInfo() {
  const transaction = useTransaction();
}
​
useUntrustedData
() => UntrustedDataMembers
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-platform-enrollment';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
​
useUser
() => UserMembers
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-platform-enrollment';
function UserProfile() {
  const user = useUser();
}
​
useMfaWebAuthnPlatformEnrollment
MfaWebAuthnPlatformEnrollmentMembers
This hook returns all methods and context available on the mfa-webauthn-platform-enrollment screen.

​
Methods

​
refuseEnrollmentOnThisDevice
void | Promise<void>
This method declines platform authenticator enrollment on the current device.
Example
import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function RefuseEnrollmentButton() {
  const { refuseEnrollmentOnThisDevice } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => refuseEnrollmentOnThisDevice()}>
      Not on This Device
    </button>
  );
}
​
reportBrowserError
void | Promise<void>
This method reports a browser-level WebAuthn error encountered during platform authenticator enrollment.
Example
import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function HandleWebAuthnError({ error }) {
  const { reportBrowserError } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => reportBrowserError({ error })}>
      Report Error
    </button>
  );
}
​
snoozeEnrollment
void | Promise<void>
This method defers the platform authenticator enrollment to a later time.
Example
import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function SnoozeButton() {
  const { snoozeEnrollment } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => snoozeEnrollment()}>
      Remind Me Later
    </button>
  );
}
​
submitPasskeyCredential
void | Promise<void>
This method submits the passkey credential created by the platform authenticator to complete enrollment.
Example
import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function EnrollButton() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​
Common/Utility Hooks

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