MfaWebauthnRoamingEnrollment

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

L’écran mfa-webauthn-roaming-enrollment invite l’utilisateur à inscrire une clé de sécurité itinérante, comme une YubiKey ou un autre authentificateur matériel FIDO2, en tant que facteur MFA.

​

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

Import Example

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

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

function MfaWebAuthnRoamingEnrollmentScreen() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Enroll Security Key
    </button>
  );
}

​

Hooks de contexte

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

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-webauthn-roaming-enrollment.

Example

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingEnrollment

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useMfaWebAuthnRoamingEnrollment · MfaWebAuthnRoamingEnrollmentMembers

Ce hook renvoie toutes les méthodes et tout le contexte disponibles pour l’écran mfa-webauthn-roaming-enrollment.

​

Méthodes

enroll · Promise<void>

Cette méthode démarre le processus d’inscription d’une clé de sécurité itinérante.

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function EnrollButton() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Enroll Security Key
    </button>
  );
}

showError · Promise<void>

Cette méthode signale une erreur WebAuthn survenue pendant l’inscription de la clé de sécurité.

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function HandleWebAuthnError({ error }) {
  const { showError } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => showError({ error })}>
      Report Error
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ShowErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur de l’API WebAuthn (navigator.credentials.create()) à signaler.

name · string · requis

Le nom de l’erreur (p. ex. 'NotAllowedError').

message · string · requis

Le message d’erreur décrivant le problème.

tryAnotherMethod · Promise<void>

Cette méthode affiche l’écran de sélection de la méthode MFA afin que l’utilisateur puisse choisir un autre facteur d’authentification.

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier 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, côté client et du développeur sur l’écran.