SignupPassword

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

La pantalla signup-password solicita la contraseña del usuario para completar la creación de la cuenta. Es el segundo paso de un flujo de registro de varios pasos, después de recopilar el identificador. También admite el registro federado mediante conexiones sociales o empresariales.

​

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.
• 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 que gestione todas las pantallas posibles.

Import Example

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

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

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </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 signup-password. Impórtalos desde @auth0/auth0-acul-react/signup-password.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el registro está asociado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/signup-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Sin contexto de organización</p>;
  }
}

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual del flujo de autenticación.

Example

import { usePrompt } from '@auth0/auth0-acul-react/signup-password';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnSignupPassword

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

Example

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

useTransaction · () => TransactionMembersOnSignupPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook administra los datos no confiables que se pasan a la pantalla, como un correo electrónico o un username rellenado previamente a partir de parámetros de la URL.

Example

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

useUser · () => UserMembers

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

Example

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

useSignupPassword · SignupPasswordMembers

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

​

Métodos

federatedSignup · Promise<void>

Este método inicia el registro mediante un proveedor de identidad federado, como Google o GitHub.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

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

Parámetros del método

Mostrar Parámetros

options

FederatedSignupPasswordPayloadOptions.

connection · string · requerido

El nombre de la conexión social o de la conexión empresarial que se va a usar (por ejemplo, google-oauth2, github).

signup · Promise<void>

Este método envía la contraseña del usuario para completar la creación de la cuenta.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SignupPasswordForm() {
  const { signup } = useSignupPassword();
  return (
    <button onClick={() => signup({ password: 'secret' })}>
      Create Account
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SignupPasswordOptions.

password · string · requerido

La contraseña de la nueva cuenta.

email · string

La dirección de correo electrónico del usuario.

username · string

El username de la nueva cuenta, si la conexión lo requiere.

phoneNumber · string

El número de teléfono del usuario, si la conexión 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 la conexión activa durante el paso signup-password, lo que permite al usuario autenticarse mediante una conexión diferente.

Example

import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';

function SwitchConnection() {
  const { switchConnection } = useSignupPassword();
  return (
    <button onClick={() => switchConnection({ connection: 'Username-Password-Authentication' })}>
      Use a different method
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SwitchConnectionOptionsSignupPassword.

connection · string · requerido

El nombre de la conexión a la que se cambiará. Use email o sms para conexiones sin contraseña, o el nombre de una 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/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 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 gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.

usePasswordValidation · Hooks

Este hook valida la contraseña del usuario conforme a los requisitos de la política de contraseñas del inquilino.