MfaPushEnrollmentQr

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

Importation

Chaque écran dispose de son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’importation partielle et l’importation racine pour chaque écran.

L’importation partielle permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
L’importation racine 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 à l’écran mfa-push-enrollment-qr. Importez-les depuis @auth0/auth0-acul-react/mfa-push-enrollment-qr.

() => BrandingMembers

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

Example

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

() => ClientMembers

Ce hook fournit les configurations liées au client, 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();
}

() => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si le flux d’AMF est limité à l’Organization. Il renvoie null lorsqu’aucun contexte d’Organization 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>;
  }
}

() => 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-push-enrollment-qr';
function FlowInfo() {
  const prompt = usePrompt();
}

() => ScreenMembersOnMfaPushEnrollmentQr

Ce hook contient des détails 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();
}

() => 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-push-enrollment-qr';
function TenantInfo() {
  const tenant = useTenant();
}

() => TransactionMembers

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

Example

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

() => 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-push-enrollment-qr';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

() => UserMembers

Ce hook fournit des renseignements sur l’utilisateur actif, notamment le username, l’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();
}

MfaPushEnrollmentQrMembers

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

Méthodes

Promise<void>

Cette méthode termine l’inscription push après que l’utilisateur a numérisé 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

MfaPushEnrollmentQrWithRememberOptions.

boolean

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

Promise<void>

Cette méthode mène à l’écran de sélection de l’authentificateur afin que l’utilisateur puisse choisir une autre méthode d’AMF à 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>
  );
}

Hooks communs et utilitaires

Hooks

Ce hook gère l’état de polling pour les écrans qui attendent une réponse asynchrone à une notification push.

Hooks

Ce hook récupère les options du thème actuel avec une configuration mise à plat à partir du contexte d’image de marque.

Hooks

Ce hook renvoie une fonction qui permet de changer la langue d’affichage sur l’écran ACUL actuel.

Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

Hooks

Ce hook lit et gère les erreurs du serveur, côté client et du développeur à l’écran.

auth0-acul-js

auth0-acul-react

auth0-android

auth0-php

Importation

Hooks de contexte

Méthodes

Hooks communs et utilitaires

​Importation

​Hooks de contexte

​Méthodes

​Hooks communs et utilitaires

Importation

Hooks de contexte

Méthodes

Hooks communs et utilitaires