LoginPasswordlessSmsOtp

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

La pantalla login-passwordless-sms-otp solicita al usuario que introduzca el código de un solo uso enviado a su número de teléfono para completar la autenticación sin contraseña por SMS.

​

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

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

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </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 login-passwordless-sms-otp. Impórtalos desde @auth0/auth0-acul-react/login-passwordless-sms-otp.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessSmsOtp

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessSmsOtp

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook expone los datos no confiables que se pasan a la pantalla, como un número de teléfono completado previamente a partir de parámetros de la URL.

Example

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

useLoginPasswordlessSmsOtp · LoginPasswordlessSmsOtpMembers

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

​

Métodos

resendOTP · Promise<void>

Este método reenvía el código de un solo uso (OTP) al número de teléfono del usuario.

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function ResendButton() {
  const { resendOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => resendOTP()}>
      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').

submitOTP · Promise<void>

Este método envía el código de un solo uso para completar la autenticación por SMS sin contraseña.

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SubmitOTPOptions.

code · string · requerido

El código de un solo uso enviado al número de teléfono del usuario.

username? · string

El número de teléfono o identificador del usuario, si el flujo lo requiere.

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 { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

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

Parámetros del método

Mostrar Parámetros

options

SwitchConnectionOptionsSmsOtp.

connection · string · requerido

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

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

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

​

Hooks comunes/utilitarios

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración del contexto de marca en formato plano.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma mostrado 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 del período de espera para el reenvío y la disponibilidad de las acciones de reenvío del código.