ResetPasswordRequest

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran reset-password-request de Universal Login.

L’écran reset-password-request s’affiche au début du flux de réinitialisation du mot de passe. Il invite l’utilisateur à saisir son nom d’utilisateur ou son adresse courriel afin de recevoir un lien de réinitialisation du mot de passe.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation à la racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’une compilation unifiée prenne en charge tous les écrans possibles.

Import Example

// importation racine
import { useResetPasswordRequest } from '@auth0/auth0-acul-react';

// importation partielle
import {
  useResetPasswordRequest,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useLoginIdentifiers,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  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 contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran reset-password-request. Importez-les depuis @auth0/auth0-acul-react/reset-password-request.

useBranding · () => BrandingMembers

Ce hook fournit la configuration de l’image de marque, notamment le logo, les couleurs et les paramètres de thème affichés sur l’écran reset-password-request.

Example

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

useClient · () => ClientMembers

Ce hook fournit des renseignements liés au client, comme id, name et logoUrl, pour l’écran reset-password-request.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si la réinitialisation du mot de passe est limitée à cette Organization. Renvoie null lorsqu’aucun contexte d’Organization n’est présent.

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

Ce hook contient des données sur le prompt en cours dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnResetPasswordRequest

Ce hook contient des détails propres à l’écran reset-password-request, y compris sa configuration et son contexte.

Example

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

useTenant · () => TenantMembers

Ce hook contient des données sur le tenant, comme son id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembersOnResetPasswordRequest

Ce hook fournit des données sur la transaction propres à l’écran reset-password-request, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook traite les données non fiables transmises à l’écran, comme une adresse courriel ou un nom d’utilisateur prérempli à partir des paramètres d’URL.

Example

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

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, y compris le username, l’email et les méthodes d’authentification disponibles.

Example

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

useResetPasswordRequest · ResetPasswordRequestMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles sur l’écran reset-password-request.

​

Méthodes

backToLogin · Promise<void>

Cette méthode redirige l’utilisateur vers l’écran de connexion et annule le flux de réinitialisation du mot de passe.

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>

Cette méthode envoie le nom d’utilisateur ou l’adresse courriel pour lancer le processus de réinitialisation du mot de passe.

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>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordRequestOptions.

username · string · requis

Le nom d’utilisateur ou l’adresse courriel du compte à réinitialiser.

captcha? · string

Le jeton de réponse CAPTCHA, requis lorsque CAPTCHA est activé pour le tenant.

​

Hooks communs et utilitaires

useLoginIdentifiers · Hooks

Ce hook renvoie les types d’identifiants de connexion (courriel, nom d’utilisateur, téléphone) configurés pour la connexion actuelle.

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie provenant du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de changer la langue d’affichage sur l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs côté serveur, côté client et côté développeur à l’écran.