LoginId

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

La pantalla login-id recopila el identificador del usuario como primer paso de un flujo de autenticación de identificador primero. Según la configuración de tu inquilino, este identificador puede ser un correo electrónico, un número de teléfono o un username. También admite el inicio de sesión con claves de acceso y Proveedores de identidad federados.

​

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.
• La importación desde la raíz le permite cargar todas las pantallas desde un único paquete, lo que resulta útil si desea una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useLoginId,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useLoginIdentifiers,
  useChangeLanguage,
  usePasskeyAutofill,
  // Métodos
  login,
  federatedLogin,
  passkeyLogin,
  pickCountryCode,
} from '@auth0/auth0-acul-react/login-id';

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </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-id. Impórtalos desde @auth0/auth0-acul-react/login-id.

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-id.

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el inicio de sesión tiene alcance de Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnLoginId

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

Example

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

useTransaction · () => TransactionMembersOnLoginId

Este hook proporciona datos específicos de la transacción para la pantalla login-id, como conexiones activas, métodos de inicio de sesión disponibles y el estado actual del flujo.

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook contiene datos no confiables que se pasan a la pantalla, como un identificador rellenado previamente a partir de parámetros de la URL.

Example

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

useLoginId · LoginIdMembers

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

​

Métodos

federatedLogin · Promise<void>

Este método inicia la autenticación a través de un proveedor de identidad federado, como Google o GitHub.

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function SocialButton() {
  const { federatedLogin } = useLoginId();
  return (
    <button onClick={() => federatedLogin({ connection: 'google-oauth2' })}>
      Sign in with Google
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

FederatedLoginPayloadOptions.

connection · string · requerido

El nombre de la conexión social que se usará (p. ej., google-oauth2, github).

login · Promise<void>

Este método envía el identificador del usuario para continuar con el siguiente paso del flujo de autenticación.

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

LoginOptions.

username · string · requerido

El identificador (correo electrónico, número de teléfono o username) que se usará para autenticarse.

captcha? · string

Valor de captcha requerido 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').

passkeyLogin · Promise<void>

Este método inicia la autenticación sin contraseña con una clave de acceso.

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function PasskeyButton() {
  const { passkeyLogin } = useLoginId();
  return (
    <button onClick={() => passkeyLogin()}>
      Sign in with Passkey
    </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').

pickCountryCode · Promise<void>

Este método navega al selector de código de país para los flujos de inicio de sesión por teléfono.

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function PhoneLogin() {
  const { pickCountryCode } = useLoginId();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country 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').

​

Hooks comunes y de utilidad

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 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 lee y administra los errores del servidor, del cliente y del desarrollador en la pantalla.

useLoginIdentifiers · Hooks

Este hook devuelve una lista de los tipos de identificador activos (email, phone, username) en el flujo actual.

usePasskeyAutofill · Hooks

Este hook habilita el autocompletado de claves de acceso en un campo de entrada para ofrecer una experiencia de inicio de sesión sin contraseña fluida.