LoginPassword

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

La pantalla login-password recopila la contraseña del usuario como segundo paso de un flujo de autenticación de tipo identifier-first. También permite cambiar a un proveedor de identidad federado o a otra conexión.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite importaciones parciales e importaciones desde la raíz para cada pantalla.

• Usar una importación parcial te permite incluir solo el código que necesitas para tu caso de uso.
• Usar una 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 { useLoginPassword } from '@auth0/auth0-acul-react';

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

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

​

Hooks de contexto

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

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

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración del cliente, como id, name y logoUrl, para la pantalla login-password.

Example

import { useClient } from '@auth0/auth0-acul-react/login-password';
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á limitado a una organización. Devuelve null cuando no hay contexto de organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</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-password';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnLoginPassword

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

Example

import { useScreen } from '@auth0/auth0-acul-react/login-password';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y sus metadatos asociados.

Example

import { useTenant } from '@auth0/auth0-acul-react/login-password';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembersOnLoginPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useLoginPassword · LoginPasswordMembers

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

​

Métodos

federatedLogin · Promise<void>

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

Example

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

function SocialButton() {
  const { federatedLogin } = useLoginPassword();
  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-password.

Example

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

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

Parámetros del método

Mostrar Parámetros

options

LoginPasswordOptions.

username · string · requerido

El identificador (correo electrónico, número de teléfono o username) con el que autenticarse.

password · string · requerido

La contraseña para autenticarse.

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

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

Parámetros del método

Mostrar Parámetros

options

SwitchConnectionOptionsLoginPassword.

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 del contexto de marca simplificada.

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