ResetPassword

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

L’écran reset-password permet aux utilisateurs de définir un nouveau mot de passe à la suite d’une demande de réinitialisation de 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.

​

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 racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez une build unifiée pour gérer tous les écrans possibles.

Import Example

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

// importation partielle
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 propres à 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 configurations d’image de marque, comme le logo, les couleurs et les paramètres du 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 au client, 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’Organization de l’utilisateur si la réinitialisation du mot de passe est limitée à une Organization. Il renvoie null lorsqu’aucun contexte Organization 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 le prompt actuel 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 détails 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 tenant, 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 une adresse courriel ou un nom d’utilisateur prérempli à partir de 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 le contexte disponibles sur l’écran reset-password.

​

Méthodes

resetPassword · Promise<void>

Cette méthode envoie le nouveau mot de passe de l’utilisateur pour 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' })}>
      Reset Password
    </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/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie à partir 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 du serveur, du client et du développeur à l’écran.

usePasswordValidation · Hooks

Ce hook valide le mot de passe de l’utilisateur selon les exigences de la politique de mot de passe du tenant.