EmailOtpChallenge - Auth0 Docs

La pantalla email-otp-challenge se muestra cuando un usuario necesita verificar su identidad introduciendo un código OTP enviado a su dirección de correo electrónico. Permite al usuario enviar el código o solicitar que se reenvíe.

Desafío de OTP por correo electrónico de ACUL

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

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

function EmailOtpChallengeScreen() {
  const { submitCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => submitCode({ 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-otp-challenge. Impórtelos desde @auth0/auth0-acul-react/email-otp-challenge.

useBranding

() => BrandingMembers

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

Example

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

useClient

() => ClientMembers

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

Example

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

useOrganization

() => OrganizationMembers

Este hook proporciona información sobre la organización del usuario si el desafío OTP tiene alcance de organización. Devuelve null cuando no hay contexto de organización.

Example

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

useScreen

() => ScreenMembersOnEmailOTPChallenge

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

Example

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

useTransaction

() => TransactionMembers

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

Example

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

useUntrustedData

() => UntrustedDataMembers

Este hook contiene 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-otp-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/email-otp-challenge';
function UserProfile() {
  const user = useUser();
}

useEmailOTPChallenge

EmailOTPChallengeMembers

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

Métodos

resendCode

Promise<void>

Este método reenvía el código OTP a la dirección de correo electrónico del usuario.

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

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

submitCode

Promise<void>

Este método envía el código OTP introducido por el usuario.

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

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