Verificación del correo electrónico al iniciar sesión

La pantalla login-email-verification solicita al usuario que introduzca un código de verificación enviado a su dirección de correo electrónico para confirmar su identidad durante el flujo de inicio de sesión.

Importación

Cada pantalla tiene su propio conjunto de Hooks y métodos. El SDK admite la importación parcial y la importación 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 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 { useLoginEmailVerification } from '@auth0/auth0-acul-react';

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

function LoginEmailVerificationForm() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

Hooks de contexto

Hooks de ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla login-email-verification. Impórtelos desde @auth0/auth0-acul-react/login-email-verification.

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 login-email-verification.

Example

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

useClient

() => ClientMembers

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

Example

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

useOrganization

() => OrganizationMembers

Este hook proporciona información sobre la organización del usuario si el inicio de sesión se realiza en el ámbito de una organización. Devuelve null cuando no hay contexto de organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-email-verification';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Sin contexto de organización</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/login-email-verification';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen

() => ScreenMembers

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

Example

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

useTransaction

() => TransactionMembers

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

Example

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

useUntrustedData

() => UntrustedDataMembers

Este hook gestiona los datos no confiables que se pasan a la pantalla, como los parámetros de la cadena de consulta de la URL.

Example

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

Este hook devuelve todos los métodos y el contexto disponibles para la pantalla login-email-verification.

Métodos

continueWithCode

Promise<void>

Este método envía el código de verificación introducido por el usuario para continuar con la verificación del correo electrónico.

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

function VerifyEmail() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ContinueWithCodeOptionPayload.

code

string

requerido

El código de verificación enviado al correo electrónico del usuario.

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

resendCode

Promise<void>

Este método solicita que se envíe un nuevo código de verificación al correo electrónico del usuario.

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

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