ResetPasswordMfaPhoneChallenge

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

L’écran reset-password-mfa-phone-challenge s’affiche durant le flux de réinitialisation du mot de passe lorsqu’une authentification multifacteur par téléphone est requise. Il invite l’utilisateur à choisir un mode 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’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 qu’une compilation unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useResetPasswordMfaPhoneChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  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 de contexte Auth0 dans l’écran reset-password-mfa-phone-challenge. Importez-les depuis @auth0/auth0-acul-react/reset-password-mfa-phone-challenge.

useBranding · () => BrandingMembers

Ce hook fournit les configurations de l’image de marque, comme le logo, les couleurs et les paramètres du thème affichés dans 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 des configurations liées au client, 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’Organization de l’utilisateur si la réinitialisation du mot de passe est propre à une Organization. Il renvoie null lorsqu’aucun contexte d’Organization 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 le prompt actuel 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 tenant, 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 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-mfa-phone-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment le username, l’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 toutes les méthodes et tout le contexte disponibles dans l’écran reset-password-mfa-phone-challenge.

​

Méthodes

continueMethod · Promise<void>

Cette méthode soumet le mode d’envoi choisi par l’utilisateur pour envoyer le code de vérification et poursuivre l’étape d’AMF du 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"

Le mode d’envoi sélectionné 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 d’AMF.

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"

Le mode d’envoi qui était affiché ou sélectionné initialement sur l’écran actuel. Ce renseignement est requis par le point de terminaison d’API pour traiter correctement l’action ‘pick-authenticator’.

• sms : Indique que l’écran actuel était celui du défi SMS.
• voice : Indique que l’écran actuel était celui du défi vocal.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction qui permet 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 sur l’écran.