MfaSmsEnrollment

Describes all the hooks and methods available to customize the Universal Login mfa-sms-enrollment screen.

The mfa-sms-enrollment screen allows the user to enroll a phone number for SMS-based MFA by entering their number and selecting a delivery method.

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.

Import Example

// root import
import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react';

// partial import
import {
  useMfaSmsEnrollment,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  continueEnrollment,
  pickCountryCode,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-sms-enrollment";

function MfaSmsEnrollmentScreen() {
  const { continueEnrollment } = useMfaSmsEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]' })}>
      Enroll Phone Number
    </button>
  );
}

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the mfa-sms-enrollment screen.

Example

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

useScreen · () => ScreenMembersOnMfaSmsEnrollment

This hook contains details specific to the mfa-sms-enrollment screen, including its configuration and context.

Example

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

useTransaction · () => TransactionMembers

This hook provides transaction-specific data for the mfa-sms-enrollment screen, such as the current MFA flow state.

Example

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

useMfaSmsEnrollment · MfaSmsEnrollmentMembers

This hook returns all methods and context available on the mfa-sms-enrollment screen.

Methods

continueEnrollment · Promise<void>

This method submits the user’s phone number to complete SMS MFA enrollment.

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

function EnrollPhoneForm() {
  const { continueEnrollment } = useMfaSmsEnrollment();
  return (
    <button onClick={() => continueEnrollment({ phone: '[phone]' })}>
      Enroll Phone Number
    </button>
  );
}

Method Parameters

Show Parameters

options

MfaSmsEnrollmentContinueOptions.

phone · string · required

The user’s phone number.

captcha · string

Optional CAPTCHA token for verification.

pickCountryCode · Promise<void>

This method navigates to the country code selection screen.

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

function PickCountryCodeButton() {
  const { pickCountryCode } = useMfaSmsEnrollment();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

This method navigates to the MFA method selection screen so the user can choose a different authentication factor.

Example

import { useMfaSmsEnrollment } from '@auth0/auth0-acul-react/mfa-sms-enrollment';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaSmsEnrollment();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </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.