ResetPasswordMfaPhoneChallenge

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

L’écran reset-password-mfa-phone-challenge s’affiche pendant le flux de réinitialisation du mot de passe lorsqu’une authentification multifacteur par téléphone est requise. Il invite l’utilisateur à choisir une méthode d’envoi (SMS ou appel vocal) pour recevoir un code de vérification et poursuivre le processus de réinitialisation.

​

Importation

Chaque écran possède 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’utilisation.
• L’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez utiliser un build unifié pour gérer tous les écrans possibles.

Import Example

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

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

function ResetPasswordMfaPhoneChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-mfa-phone-challenge';
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 s’effectue dans le contexte d’une Organisation. Retourne null si aucun contexte d’Organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-phone-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 actuelle dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaPhoneChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-mfa-phone-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 des paramètres de l’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaPhoneChallenge · ResetPasswordMfaPhoneChallengeMembers

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

​

Méthodes

continueMethod · Promise<void>

Cette méthode transmet la méthode d’envoi choisie par l’utilisateur afin d’envoyer le code de vérification et de poursuivre l’étape MFA dans le flux de réinitialisation du mot de passe.

Example

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

function SendCodeForm() {
  const { continueMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => continueMethod({ type: 'sms' })}>
      Send Code via SMS
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaPhoneChallengeContinueOptions.

type · "sms" | "voice"

La méthode d’envoi sélectionnée par l’utilisateur pour recevoir le code de vérification.

• sms : Envoie le code par message texte.
• voice : Envoie le code par appel vocal.

tryAnotherMethod · Promise<void>

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

Example

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

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaPhoneChallenge();
  return (
    <button onClick={() => tryAnotherMethod({ type: 'sms' })}>
      Try Another Method
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.

type · "sms" | "voice"

La méthode d’envoi qui a d’abord été affichée ou sélectionnée sur l’écran actuel. Ce paramètre est requis par le point de terminaison de l’API pour traiter correctement l’action ‘pick-authenticator’.

• sms : Indique que l’écran actuel correspondait à un défi SMS.
• voice : Indique que l’écran actuel correspondait à un défi vocal.

​

Hooks courants/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 actuels de l’écran.

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs du serveur, côté client et du développeur à l’écran.