MfaBeginEnrollOptions

The mfa-begin-enroll-options screen presents the available multi-factor authentication enrollment options to the user and allows them to select a factor to enroll.

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

// partial import
import {
  useMfaBeginEnrollOptions,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  enroll,
} from "@auth0/auth0-acul-react/mfa-begin-enroll-options";

function MfaBeginEnrollOptionsScreen() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Enroll with Authenticator App
    </button>
  );
}

Context Hooks

Screen-scoped hooks that provide read-only access to Auth0 context data on the mfa-begin-enroll-options screen. Import them from @auth0/auth0-acul-react/mfa-begin-enroll-options.

useBranding

() => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the mfa-begin-enroll-options screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function CustomTheme() {
  const branding = useBranding();
}

useClient

() => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the mfa-begin-enroll-options screen.

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function AppInfo() {
  const client = useClient();
}

useOrganization

() => OrganizationMembers

This hook provides information about the user’s Organization if the MFA enrollment is Organization scoped. Returns null when no Organization context is present.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
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-begin-enroll-options';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen

() => ScreenMembers

This hook contains details specific to the mfa-begin-enroll-options screen, including its configuration and context.

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
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-begin-enroll-options';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction

() => TransactionMembers

This hook provides transaction-specific data for the mfa-begin-enroll-options screen, such as available MFA factors and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
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-begin-enroll-options';
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-begin-enroll-options';
function UserProfile() {
  const user = useUser();
}

useMfaBeginEnrollOptions

MfaBeginEnrollOptionsMembers

This hook returns all methods and context available on the mfa-begin-enroll-options screen.

Methods

enroll

void | Promise<void>

This method initiates enrollment for the selected MFA factor and advances the flow to the enrollment screen for that factor.

Example

import { useMfaBeginEnrollOptions } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';

function EnrollOptions() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Enroll with Authenticator App
    </button>
  );
}