MfaVoiceChallenge

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

La pantalla mfa-voice-challenge solicita al usuario que introduzca un código de un solo uso enviado mediante una llamada de voz para completar la verificación de MFA.

​

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

// importación parcial
import {
  useMfaVoiceChallenge,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  useResend,
  // Métodos
  continueMethod,
  pickPhone,
  resendCode,
  switchToSms,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-voice-challenge";

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

​

Hooks de contexto

Hooks con ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-voice-challenge. Impórtalos desde @auth0/auth0-acul-react/mfa-voice-challenge.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-voice-challenge.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el flujo de MFA está asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaVoiceChallenge

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla mfa-voice-challenge, como el estado actual del flujo de MFA.

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaVoiceChallenge

Este hook proporciona acceso a los datos no confiables que se pasan a la pantalla, como los valores completados previamente desde parámetros de URL.

Example

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

useUser · () => UserMembers

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

Example

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

useMfaVoiceChallenge · MfaVoiceChallengeMembers

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

​

Métodos

continueMethod · Promise<void>

Este método envía el código de un solo uso recibido por llamada de voz para completar el desafío de MFA.

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

Parámetros del método

Mostrar Parámetros

options

MfaVoiceChallengeContinueOptions.

code · string · requerido

El código de verificación recibido por llamada de voz.

rememberDevice · boolean

Indicador opcional para recordar el dispositivo durante 30 días y omitir futuros desafíos de MFA.

pickPhone · Promise<void>

Este método navega a la pantalla de selección de número de teléfono.

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

function PickPhoneButton() {
  const { pickPhone } = useMfaVoiceChallenge();
  return (
    <button onClick={() => pickPhone()}>
      Usar otro número de teléfono
    </button>
  );
}

resendCode · Promise<void>

Este método vuelve a enviar al teléfono del usuario el código de un solo uso por llamada de voz.

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

switchToSms · Promise<void>

Este método cambia el desafío de MFA para que el código se entregue por SMS en lugar de por llamada de voz.

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

function SwitchToSmsButton() {
  const { switchToSms } = useMfaVoiceChallenge();
  return (
    <button onClick={() => switchToSms()}>
      Cambiar a SMS
    </button>
  );
}

tryAnotherMethod · Promise<void>

Este método navega a la pantalla de selección del método de MFA para que el usuario pueda elegir un factor de autenticación diferente.

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

​

Hooks comunes y utilitarios

useResend · Hooks

Este hook gestiona el estado y la lógica del tiempo de espera de reenvío en pantallas con funcionalidad para reenviar códigos.

useAuth0Themes · Hooks

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

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 permite leer y gestionar errores del servidor, del cliente y del desarrollador en la pantalla.