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

# MfaWebAuthnRoamingEnrollment

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

The MfaWebAuthnRoamingEnrollment class implements the `mfa-webauthn-roaming-enrollment` screen functionality. This screen is displayed when a user needs to enroll a WebAuthn roaming authenticator, for example: a security key.

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/docs-dev-actions-triggers-prototype/4MaQENhfcY-1egb6/docs/images/cdy7uua7fh8z/71Il3P3UP1Z2mpY9LdjHUQ/31e9f3e51bec04cdd0f4e78b744f6472/Screenshot_2025-05-28_at_12.19.06.png?fit=max&auto=format&n=4MaQENhfcY-1egb6&q=85&s=b449bd41d96c8ada4e5b41871dbfe0bc" alt="MfaWebAuthnRoamingEnrollment" width="363" height="488" data-path="docs/images/cdy7uua7fh8z/71Il3P3UP1Z2mpY9LdjHUQ/31e9f3e51bec04cdd0f4e78b744f6472/Screenshot_2025-05-28_at_12.19.06.png" />
</Frame>

## Constructors

Create an instance of MFA WebAuthn Roaming Enrollment screen manager:

```typescript Example theme={null}
import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();
```

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  Provides branding-related configurations, such as branding theme and settings.
</ParamField>

<ParamField body="client" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
  Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `mfa-webauthn-roaming-enrollment` screen.
</ParamField>

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  Provides information about the user's Organization, such as `id` and `name`.
</ParamField>

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}>
  Contains data about the current prompt in the authentication flow.
</ParamField>

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment">ScreenMembersOnMfaWebAuthnRoamingEnrollment</a></span>}>
  Contains details specific to the `mfa-webauthn-roaming-enrollment` screen, including its configuration and context.
</ParamField>

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}>
  Contains data related to the tenant, such as `id` and associated metadata.
</ParamField>

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}>
  Provides transaction-specific data for the `mfa-webauthn-roaming-enrollment` screen, such as active identifiers and flow states.
</ParamField>

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  Handles untrusted data passed to the SDK, such as user input during MFA WebAuthn roaming enrollment.
</ParamField>

<ParamField body="user" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}>
  Details of the active user, including `username`, `email`, and `roles`.
</ParamField>

## Methods

<ParamField body="changeLanguage" type="Promise<void>">
  This method changes the display language of the Universal Login page.

  ```typescript Example theme={null}
  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

  const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
  mfaWebAuthnRoamingEnrollment.changeLanguage({
    language: 'fr',
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
    </ParamField>

    <ParamField body="language" type="string" required>
      The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
    </ParamField>

    <ParamField body="persist?" type="&#x22;session&#x22;">
      When set to `'session'`, the selected language persists for the duration of the session.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="enroll" type="Promise<void>">
  This method initiates the WebAuthn credential creation and submits the result to the server.

  ```typescript Example theme={null}
  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

  const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
  await mfaWebAuthnRoamingEnrollment.enroll();
  ```
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  This method retrieves the array of transaction errors from the context, or an empty array if none exist.
</ParamField>

<ParamField body="showError" type="Promise<void>">
  This method submits details about a WebAuthn browser error to the server.

  ```typescript Example theme={null}
  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

  const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
  await mfaWebAuthnRoamingEnrollment.showError({
    error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [CustomOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions).
    </ParamField>

    <ParamField body="error" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/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="tryAnotherMethod" type="Promise<void>">
  This method allows the user to try another MFA method.

  ```typescript Example theme={null}
  import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

  const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
  await mfaWebAuthnRoamingEnrollment.tryAnotherMethod();
  ```
</ParamField>
