ResetPasswordRequest

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

La pantalla reset-password-request se muestra al comienzo del flujo de restablecimiento de contraseña. Solicita al usuario que introduzca su username o dirección de correo electrónico para recibir un enlace de restablecimiento de contraseña.

​

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

Import Example

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

// importación parcial
import {
  useResetPasswordRequest,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useLoginIdentifiers,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  backToLogin,
  resetPassword,
} from '@auth0/auth0-acul-react/reset-password-request';

function ResetPasswordRequestScreen() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: '[e-mail]' })}>
      Send Reset Link
    </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 reset-password-request. Impórtalos desde @auth0/auth0-acul-react/reset-password-request.

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el restablecimiento de contraseña se limita a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnResetPasswordRequest

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

Example

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

useTransaction · () => TransactionMembersOnResetPasswordRequest

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordRequest · ResetPasswordRequestMembers

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

​

Métodos

backToLogin · Promise<void>

Este método redirige al usuario a la pantalla de Login y cancela el flujo de restablecimiento de contraseña.

Example

import { useResetPasswordRequest } from '@auth0/auth0-acul-react/reset-password-request';

function BackToLoginButton() {
  const { backToLogin } = useResetPasswordRequest();
  return (
    <button onClick={() => backToLogin()}>
      Back to Login
    </button>
  );
}

resetPassword · Promise<void>

Este método envía el username o el correo electrónico para iniciar el proceso de restablecimiento de contraseña.

Example

import { useResetPasswordRequest } from '@auth0/auth0-acul-react/reset-password-request';

function ResetPasswordForm() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: '[e-mail]' })}>
      Send Reset Link
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

ResetPasswordRequestOptions.

username · string · requerido

El username o la dirección de correo electrónico de la cuenta cuya contraseña se va a restablecer.

captcha? · string

El token de respuesta del CAPTCHA, obligatorio cuando CAPTCHA está habilitado para el inquilino.

​

Hooks comunes y de utilidad

useLoginIdentifiers · Hooks

Este hook devuelve los tipos de identificador de inicio de sesión (correo electrónico, username, teléfono) configurados para la conexión actual.

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 de servidor, cliente y desarrollador en la pantalla.