MfaEmailList

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

L’écran mfa-email-list affiche la liste des adresses courriel disponibles pour la vérification MFA et permet à l’utilisateur d’en sélectionner une.

​

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

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation à la 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 gère tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaEmailList,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  goBack,
  selectMfaEmail,
} from "@auth0/auth0-acul-react/mfa-email-list";

function MfaEmailListScreen() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Select Email
    </button>
  );
}

​

Context Hooks

Hooks associés à l’écran qui fournissent un accès en lecture seule aux données de contexte Auth0 sur l’écran mfa-email-list. Importez-les depuis @auth0/auth0-acul-react/mfa-email-list.

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 sur l’écran mfa-email-list.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-email-list';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran mfa-email-list.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si le flux MFA est associé à une Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

useScreen · () => ScreenMembersOnMfaEmailList

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaEmailList · MfaEmailListMembers

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

​

Méthodes

goBack · Promise<void>

Cette méthode ramène à l’écran précédent du flux MFA.

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function BackButton() {
  const { goBack } = useMfaEmailList();
  return (
    <button onClick={() => goBack()}>
      Back
    </button>
  );
}

selectMfaEmail · Promise<void>

Cette méthode sélectionne, dans la liste, l’adresse courriel à utiliser pour la vérification MFA.

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function EmailSelector() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Use This Email
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SelectMfaEmailOptions.

index · number · requis

L’index de l’adresse courriel à sélectionner.

​

Hooks utilitaires communs

useAuth0Themes · Hooks

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