ResetPasswordMfaSmsChallenge

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

La pantalla reset-password-mfa-sms-challenge se muestra durante el flujo de restablecimiento de contraseña cuando se requiere MFA por SMS. Le pide al usuario que ingrese el código de verificación enviado a su teléfono para 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.

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

Import Example

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

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

function ResetPasswordMfaSmsChallengeScreen() {
  const { continueMfaSmsChallenge } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-mfa-sms-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-sms-challenge.

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-mfa-sms-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 tiene alcance de organización. Devuelve null cuando no hay contexto de organización.

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaSmsChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useResetPasswordMfaSmsChallenge · ResetPasswordMfaSmsChallengeMembers

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

​

Métodos

continueMfaSmsChallenge · Promise<void>

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

Example

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

function VerifyCodeForm() {
  const { continueMfaSmsChallenge } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verificar código
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordMfaSmsChallengeOptions.

code · string · requerido

El código de verificación por SMS introducido por el usuario.

getACall · Promise<void>

Este método solicita que el código de verificación se entregue mediante una llamada de voz en lugar de un SMS.

Example

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

function GetACallButton() {
  const { getACall } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      Llámame en su lugar
    </button>
  );
}

resendCode · Promise<void>

Este método reenvía el código de verificación por SMS al número de teléfono del usuario.

Example

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

function ResendCodeButton() {
  const { resendCode } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => resendCode()}>
      Reenviar código
    </button>
  );
}

tryAnotherMethod · Promise<void>

Este método lleva al usuario a seleccionar otro método de MFA.

Example

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

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Probar otro método
    </button>
  );
}

​

Hooks comunes/de utilidad

useResend · Hooks

Este hook gestiona el tiempo de espera para el reenvío y realiza un seguimiento de si el usuario puede volver a enviar el código por SMS.

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Este hook lee y gestiona los errores del servidor, del cliente y del desarrollador en la pantalla.