> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MfaWebauthnPlatformEnrollment

> Describes all the hooks and methods available to customize the Universal Login `mfa-webauthn-platform-enrollment` screen.

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.

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/docs-dev-docs-event-stream-action-templates/ZqABYvyPOuGZRvBz/docs/images/ja-jp/cdy7uua7fh8z/6hWi1hV5cPw336LB0JHYvM/7833f62a4339322bc55744c0477c4787/Screenshot_2025-05-27_at_21.04.27.png?fit=max&auto=format&n=ZqABYvyPOuGZRvBz&q=85&s=d1f8ac2549698338d74ff75d3475a343" alt="MfaWebAuthnPlatformEnrollment" width="363" height="489" data-path="docs/images/ja-jp/cdy7uua7fh8z/6hWi1hV5cPw336LB0JHYvM/7833f62a4339322bc55744c0477c4787/Screenshot_2025-05-27_at_21.04.27.png" />
</Frame>

## 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 to include only the code you need for your specific use case.
* Using root import allows you to load all screens from a single bundle, which is useful when you want a unified build to handle all possible screens.

```jsx Import Example theme={null}
// 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`.

<ParamField body="useBranding" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  This hook provides branding configurations, such as logo, colors, and theme settings displayed on the `mfa-webauthn-platform-enrollment` screen.

  ```jsx Example theme={null}
  import { useBranding } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function CustomTheme() {
    const branding = useBranding();
  }
  ```
</ParamField>

<ParamField body="useClient" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>}>
  This hook provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `mfa-webauthn-platform-enrollment` screen.

  ```jsx Example theme={null}
  import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function AppInfo() {
    const client = useClient();
  }
  ```
</ParamField>

<ParamField body="useOrganization" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  This hook provides information about the user's Organization if the MFA flow is Organization scoped. Returns `null` when no Organization context is present.

  ```jsx Example theme={null}
  import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function OrgSelector() {
    const organization = useOrganization();
    if (!organization) {
      return <p>No organization context</p>;
    }
  }
  ```
</ParamField>

<ParamField body="usePrompt" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>}>
  This hook contains data about the current prompt in the authentication flow.

  ```jsx Example theme={null}
  import { usePrompt } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function FlowInfo() {
    const prompt = usePrompt();
  }
  ```
</ParamField>

<ParamField body="useScreen" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment">ScreenMembersOnMfaWebAuthnPlatformEnrollment</a></span>}>
  This hook contains details specific to the `mfa-webauthn-platform-enrollment` screen, including its configuration and context.

  ```jsx Example theme={null}
  import { useScreen } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function ScreenDebug() {
    const screen = useScreen();
  }
  ```
</ParamField>

<ParamField body="useTenant" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>}>
  This hook contains data related to the tenant, such as `id` and associated metadata.

  ```jsx Example theme={null}
  import { useTenant } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function TenantInfo() {
    const tenant = useTenant();
  }
  ```
</ParamField>

<ParamField body="useTransaction" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TransactionMembers">TransactionMembers</a></span>}>
  This hook provides transaction-specific data for the `mfa-webauthn-platform-enrollment` screen, such as the current MFA flow state.

  ```jsx Example theme={null}
  import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function TransactionInfo() {
    const transaction = useTransaction();
  }
  ```
</ParamField>

<ParamField body="useUntrustedData" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  This hook handles untrusted data passed to the screen, such as prefilled values from URL parameters.

  ```jsx Example theme={null}
  import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function PrefilledForm() {
    const untrustedData = useUntrustedData();
  }
  ```
</ParamField>

<ParamField body="useUser" type={<span>() =&gt; <a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>}>
  This hook provides details of the active user, including `username`, `email`, and available authentication methods.

  ```jsx Example theme={null}
  import { useUser } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
  function UserProfile() {
    const user = useUser();
  }
  ```
</ParamField>

<ParamField body="useMfaWebAuthnPlatformEnrollment" type={<a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers">MfaWebAuthnPlatformEnrollmentMembers</a>}>
  This hook returns all methods and context available on the `mfa-webauthn-platform-enrollment` screen.
</ParamField>

## Methods

<ParamField body="refuseEnrollmentOnThisDevice" type="Promise<void>">
  This method declines platform authenticator enrollment on the current device.

  ```jsx Example theme={null}
  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>
    );
  }
  ```
</ParamField>

<ParamField body="reportBrowserError" type="Promise<void>">
  This method reports a browser-level WebAuthn error encountered during platform authenticator enrollment.

  ```jsx Example theme={null}
  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>
    );
  }
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [ReportBrowserErrorOptions](/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions).
    </ParamField>

    <ParamField body="error" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails">WebAuthnErrorDetails</a></span>} required>
      The error object from the WebAuthn API (`navigator.credentials.create()`) to be reported.

      <ParamField body="name" type="string" required>
        The name of the error (e.g., `'NotAllowedError'`).
      </ParamField>

      <ParamField body="message" type="string" required>
        The error message describing what went wrong.
      </ParamField>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="snoozeEnrollment" type="Promise<void>">
  This method defers the platform authenticator enrollment to a later time.

  ```jsx Example theme={null}
  import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

  function SnoozeButton() {
    const { snoozeEnrollment } = useMfaWebAuthnPlatformEnrollment();
    return (
      <button onClick={() => snoozeEnrollment()}>
        Remind Me Later
      </button>
    );
  }
  ```
</ParamField>

<ParamField body="submitPasskeyCredential" type="Promise<void>">
  This method submits the passkey credential created by the platform authenticator to complete enrollment.

  ```jsx Example theme={null}
  import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

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

## Common/Utility Hooks

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useAuth0Themes">useAuth0Themes</a>} type="Hooks">
  This hook gets the current theme options with flattened configuration from branding context.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useChangeLanguage">useChangeLanguage</a>} type="Hooks">
  This hook returns a function for changing the display language on the current ACUL screen.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useCurrentScreen">useCurrentScreen</a>} type="Hooks">
  This hook gets the current screen context and state.
</ParamField>

<ParamField body={<a href="/docs/libraries/acul/react-sdk/API-Reference/Hooks/useErrors">useErrors</a>} type="Hooks">
  This hook reads and manages server, client, and developer errors on the screen.
</ParamField>