ResetPasswordMfaSmsChallenge

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

L’écran reset-password-mfa-sms-challenge s’affiche pendant le flux de réinitialisation du mot de passe lorsqu’une authentification multifacteur par SMS est requise. Il invite l’utilisateur à saisir le code de vérification envoyé à son téléphone pour poursuivre le processus de réinitialisation.

​

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’utilisation de l’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’utilisation de l’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une compilation unifiée prenne en charge tous les écrans possibles.

Import Example

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

// import partiel
import {
  useResetPasswordMfaSmsChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // Utility hooks
  useChangeLanguage,
  // Méthodes
  continueMfaSmsChallenge,
  getACall,
  resendCode,
  tryAnotherMethod,
} from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';

function ResetPasswordMfaSmsChallengeScreen() {
  const { continueMfaSmsChallenge } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verify Code
    </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-mfa-sms-challenge. Importez-les depuis @auth0/auth0-acul-react/reset-password-mfa-sms-challenge.

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';
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-mfa-sms-challenge.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des informations sur l’organisation de l’utilisateur si la réinitialisation du mot de passe est associée à une organisation. Retourne null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaSmsChallenge

Ce hook contient les détails propres à l’écran reset-password-mfa-sms-challenge, y compris sa configuration et son contexte.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';
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-mfa-sms-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaSmsChallenge · ResetPasswordMfaSmsChallengeMembers

Ce hook renvoie l’ensemble des méthodes et du contexte disponibles sur l’écran reset-password-mfa-sms-challenge.

​

Méthodes

continueMfaSmsChallenge · Promise<void>

Cette méthode envoie le code de vérification par SMS afin de poursuivre l’étape MFA dans le flux de réinitialisation du mot de passe.

Example

import { useResetPasswordMfaSmsChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';

function VerifyCodeForm() {
  const { continueMfaSmsChallenge } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Vérifier le code
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaSmsChallengeOptions.

code · string · requis

Le code de vérification par SMS saisi par l’utilisateur.

getACall · Promise<void>

Cette méthode demande l’envoi du code de vérification par appel vocal plutôt que par SMS.

Example

import { useResetPasswordMfaSmsChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';

function GetACallButton() {
  const { getACall } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      M’appeler à la place
    </button>
  );
}

resendCode · Promise<void>

Cette méthode renvoie le code de vérification par SMS au numéro de téléphone de l’utilisateur.

Example

import { useResetPasswordMfaSmsChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';

function ResendCodeButton() {
  const { resendCode } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => resendCode()}>
      Renvoyer le code
    </button>
  );
}

tryAnotherMethod · Promise<void>

Cette méthode redirige l’utilisateur pour qu’il sélectionne une autre méthode MFA.

Example

import { useResetPasswordMfaSmsChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-sms-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Essayer une autre méthode
    </button>
  );
}

​

Hooks communs/utilitaires

useResend · Hooks

Ce hook gère l’état du délai avant un nouveau renvoi et indique si l’utilisateur peut renvoyer le code SMS.

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie issue 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 permet de lire et de gérer les erreurs du serveur, de l’application et du développeur à l’écran.