MfaPushEnrollmentQr - Auth0 Docs

L’écran mfa-push-enrollment-qr affiche un code QR que l’utilisateur peut numériser avec l’application Auth0 Guardian pour finaliser l’inscription aux notifications push.

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

Import Example

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

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

function MfaPushEnrollmentQrScreen() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Pick Authenticator
    </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 mfa-push-enrollment-qr. Importez-les depuis @auth0/auth0-acul-react/mfa-push-enrollment-qr.

useBranding

() => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';
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-push-enrollment-qr.

Example

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

useOrganization

() => OrganizationMembers

Ce hook fournit des renseignements sur l’Organisation de l’utilisateur si le flux MFA s’exécute dans le contexte d’une Organisation. Retourne null lorsqu’aucun contexte d’Organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-push-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 en cours dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen

() => ScreenMembersOnMfaPushEnrollmentQr

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

Example

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

useTransaction

() => TransactionMembers

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

Example

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

useUntrustedData

() => UntrustedDataMembers

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

useMfaPushEnrollmentQr

MfaPushEnrollmentQrMembers

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

Méthodes

continueMethod

Promise<void>

Cette méthode termine l’inscription à Push après que l’utilisateur a balayé le code QR avec l’application Auth0 Guardian.

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function ContinueButton() {
  const { continueMethod } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => continueMethod({ rememberDevice: true })}>
      Continue
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaPushEnrollmentQrWithRememberOptions.

rememberDevice?

boolean

Si true, l’appareil sera mémorisé et l’authentification MFA ne sera plus requise sur cet appareil.

pickAuthenticator

Promise<void>

Cette méthode redirige vers l’écran de sélection de l’authentificateur afin que l’utilisateur puisse choisir une autre méthode MFA à inscrire.

Example

import { useMfaPushEnrollmentQr } from '@auth0/auth0-acul-react/mfa-push-enrollment-qr';

function PickAuthenticatorButton() {
  const { pickAuthenticator } = useMfaPushEnrollmentQr();
  return (
    <button onClick={() => pickAuthenticator()}>
      Pick Authenticator
    </button>
  );
}