MfaBeginEnrollOptions

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

L’écran mfa-begin-enroll-options présente à l’utilisateur les options d’inscription à l’authentification multifacteur offertes et lui permet de choisir un facteur à inscrire.

​

Importation

Chaque écran a son propre ensemble de hooks et de méthodes. Le SDK prend en charge partial import et root import pour chaque écran.

• L’utilisation de partial import vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’utilisation de root import vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez une version unifiée capable de gérer tous les écrans possibles.

Import Example

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

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

function MfaBeginEnrollOptionsScreen() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Enroll with Authenticator App
    </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-begin-enroll-options. Importez-les depuis @auth0/auth0-acul-react/mfa-begin-enroll-options.

useBranding · () => BrandingMembers

Ce hook fournit les configurations d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran mfa-begin-enroll-options.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
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-begin-enroll-options.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si l’inscription à l’AMF est associée à une organisation. Il retourne null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran mfa-begin-enroll-options, comme les facteurs d’AMF disponibles et l’état actuel du flux.

Example

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

useMfaBeginEnrollOptions · MfaBeginEnrollOptionsMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles sur l’écran mfa-begin-enroll-options.

​

Méthodes

enroll · Promise<void>

Cette méthode lance l’inscription du facteur d’AMF sélectionné et fait passer le flux à l’écran d’inscription correspondant.

Example

import { useMfaBeginEnrollOptions } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';

function EnrollOptions() {
  const { enroll } = useMfaBeginEnrollOptions();
  return (
    <button onClick={() => enroll({ action: 'otp' })}>
      Enroll with Authenticator App
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaEnrollOptions.

action · string · requis

L’action qui indique quel facteur inscrire. Une des valeurs suivantes : “push-notification”, “otp”, “sms”, “phone”, “voice” ou “webauthn-roaming”.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

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