MfaEmailChallenge

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

L’écran mfa-email-challenge invite l’utilisateur à saisir un code à usage unique envoyé à son adresse courriel pour compléter la vérification MFA.

​

Importation

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’une version unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaEmailChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useResend,
  useChangeLanguage,
  // Méthodes
  continueMethod,
  pickEmail,
  resendCode,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-email-challenge";

function MfaEmailChallengeScreen() {
  const { continueMethod } = useMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ 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 mfa-email-challenge. Importez-les depuis @auth0/auth0-acul-react/mfa-email-challenge.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les réglages du thème affichés sur l’écran mfa-email-challenge.

Example

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des informations sur l’Organisation de l’utilisateur si le flux MFA est défini dans le contexte d’une Organisation. Il renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

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

useScreen · () => ScreenMembersOnMfaEmailChallenge

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

Example

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

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran mfa-email-challenge, comme l’état actuel du flux MFA.

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaEmailChallenge

Ce hook gère les données non fiables transmises à l’écran, comme les valeurs préremplies à partir des paramètres d’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useMfaEmailChallenge · MfaEmailChallengeMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles dans l’écran mfa-email-challenge.

​

Méthodes

continueMethod · Promise<void>

Cette méthode soumet le code à usage unique saisi par l’utilisateur pour terminer la vérification MFA par courriel.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function EmailChallengeForm() {
  const { continueMethod } = useMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456', rememberDevice: true })}>
      Vérifier
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ContinuePayloadOptions.

code · string · requis

Le code saisi par l’utilisateur

rememberDevice? · boolean

Indique si l’appareil doit être mémorisé

pickEmail · Promise<void>

Cette méthode redirige vers l’écran de sélection du courriel si plusieurs adresses courriel sont disponibles pour la vérification.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function PickEmailButton() {
  const { pickEmail } = useMfaEmailChallenge();
  return (
    <button onClick={() => pickEmail()}>
      Utiliser une autre adresse courriel
    </button>
  );
}

resendCode · Promise<void>

Cette méthode demande l’envoi d’un nouveau code à usage unique à l’adresse courriel de l’utilisateur.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

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

tryAnotherMethod · Promise<void>

Cette méthode redirige vers l’écran de sélection de la méthode MFA afin que l’utilisateur puisse choisir un autre facteur d’authentification.

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

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

​

Hooks communs et utilitaires

useResend · Hooks

Ce hook gère l’état et la logique du délai avant un nouveau renvoi pour les écrans offrant la fonctionnalité de renvoi de code.

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 modifier 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, application et développeur sur l’écran.