ResetPasswordMfaPushChallengePush

Describes all the hooks and methods available to customize the Universal Login reset-password-mfa-push-challenge-push screen.

The reset-password-mfa-push-challenge-push screen is displayed during the password reset flow when multi-factor authentication is required via a push notification. It prompts the user to approve the request on their enrolled mobile device 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, which is useful when you want a unified build to handle all possible screens.

Import Example

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

// partial import
import {
  useResetPasswordMfaPushChallengePush,
  // Context hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Common hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useMfaPolling,
  // Utility hooks
  useChangeLanguage,
  // Methods
  continueMethod,
  enterCodeManually,
  resendPushNotification,
  tryAnotherMethod,
} from '@auth0/auth0-acul-react/reset-password-mfa-push-challenge-push';

function ResetPasswordMfaPushChallengePushScreen() {
  const { resendPushNotification } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification()}>
      Resend Push Notification
    </button>
  );
}

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaPushChallengePush

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useResetPasswordMfaPushChallengePush · ResetPasswordMfaPushChallengePushMembers

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

Methods

continueMethod · Promise<void>

This method continues the password reset flow after the user has approved the push notification on their mobile device.

Example

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

function ContinueButton() {
  const { continueMethod } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

enterCodeManually · Promise<void>

This method navigates the user to enter the OTP code manually instead of waiting for push notification approval.

Example

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

function EnterCodeButton() {
  const { enterCodeManually } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => enterCodeManually()}>
      Enter Code Manually
    </button>
  );
}

resendPushNotification · Promise<void>

This method resends the push notification to the user’s enrolled mobile device.

Example

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

function ResendButton() {
  const { resendPushNotification } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification()}>
      Resend Push Notification
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

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

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

Common/Utility Hooks

useMfaPolling · Hooks

This hook manages MFA push notification polling, repeatedly checking the push challenge endpoint until the user approves or denies the request.

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.