ResetPasswordMfaPhoneChallenge

Describe los hooks y métodos disponibles para personalizar la pantalla reset-password-mfa-phone-challenge de Universal Login.

La pantalla reset-password-mfa-phone-challenge se muestra durante el flujo de restablecimiento de contraseña cuando se requiere autenticación multifactor mediante teléfono. Solicita al usuario que elija un método de envío (SMS o llamada de voz) para recibir un código de verificación y continuar con el proceso de restablecimiento.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite la importación parcial y la importación desde la raíz para cada pantalla.

• Usar la importación parcial le permite incluir solo el código que necesita para su caso de uso específico.
• Usar la importación desde la raíz le permite cargar todas las pantallas desde un único bundle, lo que resulta útil cuando desea una compilación unificada para gestionar todas las pantallas posibles.

Import Example

// importación raíz
import { useResetPasswordMfaPhoneChallenge } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useResetPasswordMfaPhoneChallenge,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continueMethod,
  tryAnotherMethod,
} from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';

function ResetPasswordMfaPhoneChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

​

Hooks de contexto

Hooks asociados a la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla reset-password-mfa-phone-challenge. Impórtalos desde @auth0/auth0-acul-react/reset-password-mfa-phone-challenge.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y la configuración del tema que se muestran en la pantalla reset-password-mfa-phone-challenge.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla reset-password-mfa-phone-challenge.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el restablecimiento de contraseña está limitado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual del flujo de autenticación.

Example

import { usePrompt } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordMfaPhoneChallenge

Este hook contiene detalles específicos de la pantalla reset-password-mfa-phone-challenge, incluida su configuración y contexto.

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y sus metadatos asociados.

Example

import { useTenant } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla reset-password-mfa-phone-challenge, como las conexiones activas y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook gestiona datos no confiables que se pasan a la pantalla, como un correo electrónico o username completado previamente a partir de parámetros de la URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Este hook proporciona información sobre el usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaPhoneChallenge · ResetPasswordMfaPhoneChallengeMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla reset-password-mfa-phone-challenge.

​

Métodos

continueMethod · Promise<void>

Este método envía el método de entrega elegido por el usuario para enviar el código de verificación y continuar con el paso de MFA en el flujo de restablecimiento de contraseña.

Example

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

function SendCodeForm() {
  const { continueMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaPhoneChallengeContinueOptions.

type · "sms" | "voice"

El método de entrega seleccionado por el usuario para recibir el código de verificación.

• sms: Envía el código por mensaje de texto.
• voice: Envía el código mediante una llamada de voz.

tryAnotherMethod · Promise<void>

Este método redirige al usuario para que seleccione un método de MFA diferente.

Example

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

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => tryAnotherMethod({ type: 'sms' })}>
      Try Another Method
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.

type · "sms" | "voice"

El método de entrega que se mostró o seleccionó inicialmente en la pantalla actual. La API lo requiere para procesar correctamente la acción ‘pick-authenticator’.

• sms: Indica que la pantalla actual era para el desafío por SMS.
• voice: Indica que la pantalla actual era para el desafío de voz.

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración plana del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma mostrado en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook permite leer y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.