ResetPasswordMfaVoiceChallenge

The reset-password-mfa-voice-challenge screen is displayed during the password reset flow when multi-factor authentication is required via a voice call. It prompts the user to enter the verification code delivered to their phone to continue the reset process.

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 useful when you want a unified build to handle all possible screens.

Import Example

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

// partial import
import {
  useResetPasswordMfaVoiceChallenge,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // Utility hooks
  useChangeLanguage,
  // Methods
  continueMethod,
  resendCode,
  switchToSms,
  tryAnotherMethod,
} from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function ResetPasswordMfaVoiceChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaVoiceChallenge();
  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 reset-password-mfa-voice-challenge screen. Import them from @auth0/auth0-acul-react/reset-password-mfa-voice-challenge.

useBranding

() => BrandingMembers

This hook provides branding configurations, such as logo, colors, and theme settings displayed on the reset-password-mfa-voice-challenge screen.

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';
function CustomTheme() {
  const branding = useBranding();
}

useClient

() => ClientMembers

This hook provides client-related configurations, such as id, name, and logoUrl, for the reset-password-mfa-voice-challenge screen.

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';
function AppInfo() {
  const client = useClient();
}

useOrganization

() => OrganizationMembers

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

Example

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

useScreen

() => ScreenMembersOnResetPasswordMfaVoiceChallenge

This hook contains details specific to the reset-password-mfa-voice-challenge screen, including its configuration and context.

Example

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

useTransaction

() => TransactionMembers

This hook provides transaction-specific data for the reset-password-mfa-voice-challenge screen, such as active connections and current flow state.

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData

() => UntrustedDataMembers

This hook handles untrusted data passed to the screen, such as a prefilled email or username from URL parameters.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';
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/reset-password-mfa-voice-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaVoiceChallenge

ResetPasswordMfaVoiceChallengeMembers

This hook returns all methods and context available on the reset-password-mfa-voice-challenge screen.

Methods

continueMethod

void | Promise<void>

This method submits the voice verification code to continue the MFA step in the password reset flow.

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

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

Show Parameters

payload

ResetPasswordMfaVoiceChallengeContinueOptions

required

code

string

required

The voice verification code entered by the user.

resendCode

void | Promise<void>

This method resends the voice verification code to the user’s phone number.

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function ResendCodeButton() {
  const { resendCode } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

Show Parameters

payload

CustomOptions

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

Any additional custom options.

switchToSms

void | Promise<void>

This method switches the MFA delivery method from voice call to SMS.

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function SwitchToSmsButton() {
  const { switchToSms } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => switchToSms()}>
      Switch to SMS
    </button>
  );
}

Show Parameters

payload

CustomOptions

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

Any additional custom options.

tryAnotherMethod

void | Promise<void>

This method navigates the user to select a different MFA method.

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}