Inicio de sesión

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

La pantalla login recopila el identificador y la contraseña del usuario. Según tu inquilino, este identificador puede ser un correo electrónico, un número de teléfono o un username. También admite la autenticación mediante proveedores de identidad federados.

​

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

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

function LoginForm() {
  const { login, federatedLogin } = useLogin();
  return (
    <button onClick={() => login({ username: "[e-mail]", password: "secret" })}>
      Sign In
    </button>
  );
}

​

Hooks de contexto

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useScreen · () => ScreenMembersOnLogin

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

Example

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

useTransaction · () => TransactionMembersOnLogin

Este hook proporciona datos específicos de la transacción para la pantalla login, 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';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Este hook maneja los datos no confiables que se pasan a la pantalla, como un username precompletado a partir de parámetros de la URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/login';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Este hook proporciona detalles del usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/login';
function UserProfile() {
  const user = useUser();
}

useLogin · LoginMembers

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

​

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

function SocialButton() {
  const { federatedLogin } = useLogin();
  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 va a usar (por ejemplo, google-oauth2, github).

login · Promise<void>

Este método envía las credenciales del usuario para completar la autenticación en la pantalla login.

Example

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

function LoginForm() {
  const { login } = useLogin();
  return (
    <button onClick={() => login({ username: '[e-mail]', password: 'secret' })}>
      Sign In
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

LoginPayloadOptions.

username · string · requerido

El username o correo electrónico que se usará para autenticarse.

password · string · requerido

La contraseña para la autenticación.

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').

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

function PhoneLogin() {
  const { pickCountryCode } = useLogin();
  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/de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración consolidada 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 de desarrollo en la pantalla.

useLoginIdentifiers · Hooks

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