EmailIdentifierChallenge

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

La pantalla email-identifier-challenge se muestra cuando un usuario necesita verificar su identidad introduciendo el code enviado a su dirección de correo electrónico. Permite al usuario enviar el code, volver a enviarlo o regresar al paso anterior.

​

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.
• 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 que gestione todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useEmailIdentifierChallenge,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  submitEmailChallenge,
  resendCode,
  returnToPrevious,
} from '@auth0/auth0-acul-react/email-identifier-challenge';

function EmailIdentifierChallengeScreen() {
  const { submitEmailChallenge } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => submitEmailChallenge({ code: '123456' })}>Submit</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 email-identifier-challenge. Impórtalos desde @auth0/auth0-acul-react/email-identifier-challenge.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes de tema que se muestran en la pantalla email-identifier-challenge.

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el desafío de correo electrónico está limitado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnEmailIdentifierChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook expone datos no confiables que se pasan a la pantalla, como parámetros rellenados previamente desde cadenas de consulta de URL.

Example

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

useUser · () => UserMembers

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

Example

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

useEmailIdentifierChallenge · EmailIdentifierChallengeMembers

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

​

Métodos

resendCode · Promise<void>

Este método reenvía el code de verificación a la dirección de correo electrónico del usuario.

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function ResendButton() {
  const { resendCode } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

returnToPrevious · Promise<void>

Este método devuelve al usuario al paso anterior del flujo de autenticación.

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      Back
    </button>
  );
}

submitEmailChallenge · Promise<void>

Este método envía el code de verificación por correo electrónico que introdujo el usuario.

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function SubmitButton() {
  const { submitEmailChallenge } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => submitEmailChallenge({ code: '123456' })}>
      Continue
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

EmailChallengeOptions.

code · string · requerido

El code de verificación enviado a la dirección de correo electrónico del usuario.

captcha? · string

El token de respuesta del CAPTCHA, si CAPTCHA está habilitado para este inquilino.

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma que se muestra 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.

useResend · Hooks

Este hook gestiona el estado de reenvío y la lógica del tiempo de espera para el código de verificación por correo electrónico.