MfaEmailChallenge

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

La pantalla mfa-email-challenge solicita al usuario que introduzca un código de un solo uso enviado a su dirección de correo electrónico para completar la verificación de MFA.

​

Importación

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

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

Import Example

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

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

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

​

Hooks de contexto

Hooks del ámbito de la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla mfa-email-challenge. Impórtalos desde @auth0/auth0-acul-react/mfa-email-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 mfa-email-challenge.

Example

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

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-email-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á limitado al ámbito de una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnMfaEmailChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaEmailChallenge

Este hook contiene los datos no confiables que se pasan a la pantalla, como valores rellenados previamente a partir de parámetros de URL.

Example

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

useMfaEmailChallenge · MfaEmailChallengeMembers

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

​

Métodos

continueMethod · Promise<void>

Este método envía el código de un solo uso introducido por el usuario para completar el desafío de MFA por correo electrónico.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function EmailChallengeForm() {
  const { continueMethod } = useMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456', rememberDevice: true })}>
      Verificar
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ContinuePayloadOptions.

code · string · requerido

El código introducido por el usuario

rememberDevice? · boolean

Indica si se debe recordar el dispositivo

pickEmail · Promise<void>

Este método navega a la pantalla de selección de correo electrónico si hay varias direcciones de correo electrónico disponibles para el desafío.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function PickEmailButton() {
  const { pickEmail } = useMfaEmailChallenge();
  return (
    <button onClick={() => pickEmail()}>
      Usar otro correo electrónico
    </button>
  );
}

resendCode · Promise<void>

Este método solicita que se envíe un nuevo código de un solo uso a la dirección de correo electrónico del usuario.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaEmailChallenge();
  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 período de espera para el reenvío en pantallas con funcionalidad de reenvío de código.

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con una configuración consolidada a partir del 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 permite consultar y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.