MfaOtpEnrollmentQr

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

The mfa-otp-enrollment-qr screen displays a QR code for the user to scan with their authenticator app to complete OTP enrollment.

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

// partial import
import {
  useMfaOtpEnrollmentQr,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Methods
  continueMethod,
  toggleView,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-otp-enrollment-qr";

function MfaOtpEnrollmentQrScreen() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentQr

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useMfaOtpEnrollmentQr · MfaOtpEnrollmentQrMembers

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

Methods

continueMethod · Promise<void>

This method submits the OTP code to verify the authenticator app is configured correctly and complete enrollment.

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function EnrollmentQrForm() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify
    </button>
  );
}

Method Parameters

Show Parameters

options

MfaOtpEnrollmentQrContinueOptions.

code · string · required

The OTP code entered by the user.

toggleView · Promise<void>

This method toggles the enrollment view between QR code and manual entry (secret key) modes.

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => toggleView()}>
      Enter Code Manually
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaOtpEnrollmentQr();
  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.