LoginPasswordlessEmailCode

Describe todos los hooks y métodos disponibles para personalizar la pantalla login-passwordless-email-code de Universal Login.

La pantalla login-passwordless-email-code solicita al usuario que introduzca un code de un solo uso enviado a su correo electrónico para completar la autenticación sin contraseña.

​

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

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

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Hooks de contexto

Hooks específicos de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla login-passwordless-email-code. Impórtalos desde @auth0/auth0-acul-react/login-passwordless-email-code.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el inicio de sesión está dentro del ámbito de una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessEmailCode

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessEmailCode

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona acceso a los datos no confiables que se pasan a la pantalla, como una dirección de correo electrónico rellenada previamente a partir de parámetros de URL.

Example

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

useLoginPasswordlessEmailCode · LoginPasswordlessEmailCodeMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla login-passwordless-email-code.

​

Métodos

resendCode · Promise<void>

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

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

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

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

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

submitCode · Promise<void>

Este método envía el code de un solo uso para completar la autenticación sin contraseña por correo electrónico.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SubmitCodeOptions.

code · string | number · requerido

El code de un solo uso enviado a la dirección de correo electrónico del usuario.

captcha? · string

Valor de captcha obligatorio cuando la detección de bots está habilitada en el inquilino.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

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

switchConnection · Promise<void>

Este método cambia a una conexión de autenticación alternativa sin reiniciar el flujo.

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      Use SSO
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SwitchConnectionOptionsEmailCode.

connection · string · requerido

El nombre de la conexión a la que se cambiará. Use ‘email’ o ‘sms’ para autenticación sin contraseña, o un nombre de conexión de base de datos para la autenticación con contraseña.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

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

​

Hooks comunes y utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración plana 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 leer y administrar los errores del servidor, del cliente y del desarrollador en la pantalla.

useResend · Hooks

Este hook administra el estado de espera para el reenvío y la disponibilidad de las acciones de reenvío de code.