MfaOtpEnrollmentQr

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran mfa-otp-enrollment-qr dans Universal Login.

L’écran mfa-otp-enrollment-qr affiche un code QR que l’utilisateur doit numériser avec son application d’authentification pour terminer l’inscription à l’OTP.

​

Import

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’utilisation.
• L’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez qu’une seule compilation prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaOtpEnrollmentQr,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  continueMethod,
  toggleView,
  tryAnotherMethod,
} from "@auth0/auth0-acul-react/mfa-otp-enrollment-qr";

function MfaOtpEnrollmentQrScreen() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Hooks de contexte

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

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 mfa-otp-enrollment-qr.

Example

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

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran mfa-otp-enrollment-qr.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des informations sur l’organisation de l’utilisateur si le flux MFA est limité à une organisation. Il retourne null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentQr

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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-otp-enrollment-qr';
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-otp-enrollment-qr';
function UserProfile() {
  const user = useUser();
}

useMfaOtpEnrollmentQr · MfaOtpEnrollmentQrMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles dans l’écran mfa-otp-enrollment-qr.

​

Méthodes

continueMethod · Promise<void>

Cette méthode transmet le code OTP pour vérifier que l’application d’authentification est correctement configurée et finaliser l’inscription.

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function EnrollmentQrForm() {
  const { continueMethod } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Vérifier
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaOtpEnrollmentQrContinueOptions.

code · string · requis

Le code OTP saisi par l’utilisateur.

toggleView · Promise<void>

Cette méthode fait basculer l’affichage de l’inscription entre les modes code QR et saisie manuelle (clé secrète).

Example

import { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentQr();
  return (
    <button onClick={() => toggleView()}>
      Saisir le code manuellement
    </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 { useMfaOtpEnrollmentQr } from '@auth0/auth0-acul-react/mfa-otp-enrollment-qr';

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

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec la configuration aplanie 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 lit et gère les erreurs serveur, côté client et de développement à l’écran.