MfaWebauthnPlatformEnrollment

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

L’écran mfa-webauthn-platform-enrollment invite l’utilisateur à inscrire un authentificateur de plateforme, comme Touch ID ou Windows Hello, comme facteur MFA.

​

Importation

Chaque écran possède 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 une compilation unifiée capable de gérer tous les écrans possibles.

Import Example

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

// import partiel
import {
  useMfaWebAuthnPlatformEnrollment,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  refuseEnrollmentOnThisDevice,
  reportBrowserError,
  snoozeEnrollment,
  submitPasskeyCredential,
} from "@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment";

function MfaWebAuthnPlatformEnrollmentScreen() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </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-webauthn-platform-enrollment. Importez-les depuis @auth0/auth0-acul-react/mfa-webauthn-platform-enrollment.

useBranding · () => BrandingMembers

Ce hook fournit la configuration de l’image de marque, comme le logo, les couleurs et les paramètres du thème affichés sur l’écran mfa-webauthn-platform-enrollment.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-webauthn-platform-enrollment.

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-webauthn-platform-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. Renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformEnrollment

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

Example

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

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-platform-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 issues des paramètres d’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des détails sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function UserProfile() {
  const user = useUser();
}

useMfaWebAuthnPlatformEnrollment · MfaWebAuthnPlatformEnrollmentMembers

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

​

Méthodes

refuseEnrollmentOnThisDevice · Promise<void>

Cette méthode refuse l’inscription d’un authentificateur de plateforme sur l’appareil actuel.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function RefuseEnrollmentButton() {
  const { refuseEnrollmentOnThisDevice } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => refuseEnrollmentOnThisDevice()}>
      Not on This Device
    </button>
  );
}

reportBrowserError · Promise<void>

Cette méthode signale une erreur WebAuthn du navigateur survenue pendant l’inscription d’un authentificateur de plateforme.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

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

Paramètres de la méthode

Afficher Paramètres

options

ReportBrowserErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur provenant 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.

snoozeEnrollment · Promise<void>

Cette méthode reporte l’inscription de l’authentificateur de plateforme à plus tard.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function SnoozeButton() {
  const { snoozeEnrollment } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => snoozeEnrollment()}>
      Remind Me Later
    </button>
  );
}

submitPasskeyCredential · Promise<void>

Cette méthode envoie les données d’identification de la clé d’accès créées par l’authentificateur de plateforme pour finaliser l’inscription.

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function EnrollButton() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie 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 lit et gère les erreurs du serveur, de l’application et de développement sur l’écran.