Réinitialisation du mot de passe

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

L’écran reset-password permet aux utilisateurs de définir un nouveau mot de passe après une demande de réinitialisation du mot de passe. Il s’affiche dans le flux de réinitialisation du mot de passe et oblige l’utilisateur à saisir et à confirmer son nouveau mot de passe.

​

Import

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’import partiel et l’import racine pour chaque écran.

• L’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• L’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’un build unifié prenne en charge tous les écrans possibles.

Import Example

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

// import partiel
import {
  useResetPassword,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  usePasswordValidation,
  // Méthodes
  resetPassword,
} from '@auth0/auth0-acul-react/reset-password';

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Reset Password
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran reset-password.

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite active dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnResetPassword

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

Example

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

useTenant · () => TenantMembers

Ce hook contient des données liées au locataire, comme id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembersOnResetPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPassword · ResetPasswordMembers

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

​

Méthodes

resetPassword · Promise<void>

Cette méthode envoie le nouveau mot de passe de l’utilisateur afin de terminer le flux de réinitialisation du mot de passe.

Example

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Réinitialisation du mot de passe
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordOptions.

password-reset · string · requis

Le nouveau mot de passe du compte.

re-enter-password · string · requis

Confirmation du nouveau mot de passe. Doit correspondre à password-reset.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs serveur, client et développeur sur l’écran.

usePasswordValidation · Hooks

Ce hook valide le mot de passe de l’utilisateur selon les exigences de la stratégie de mot de passe du locataire.