MfaWebauthnPlatformChallenge

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

L’écran mfa-webauthn-platform-challenge invite l’utilisateur à effectuer une vérification AMF à l’aide d’un authentificateur de plateforme, comme Touch ID ou Windows Hello, intégré à son appareil.

​

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 racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une version unifiée prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaWebAuthnPlatformChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  reportBrowserError,
  tryAnotherMethod,
  verify,
} from "@auth0/auth0-acul-react/mfa-webauthn-platform-challenge";

function MfaWebAuthnPlatformChallengeScreen() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Platform Authenticator
    </button>
  );
}

​

Hooks de contexte

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

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-webauthn-platform-challenge.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran mfa-webauthn-platform-challenge.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si le flux d’AMF est limité à l’Organization. Renvoie null lorsqu’aucun contexte d’Organization n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Aucun contexte d’organisation</p>;
  }
}

usePrompt · () => 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-webauthn-platform-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformChallenge

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

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au tenant, comme id et les metadata associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme des valeurs préremplies à partir de paramètres d’URL.

Example

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

useMfaWebAuthnPlatformChallenge · MfaWebAuthnPlatformChallengeMembers

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

​

Méthodes

reportBrowserError · Promise<void>

Cette méthode signale une erreur WebAuthn au niveau du navigateur survenue pendant la vérification avec l’authentificateur de plateforme.

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

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

Paramètres de la méthode

Afficher Paramètres

options

MfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur de la WebAuthn API (navigator.credentials.get()) à 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 mène à l’écran de sélection de la méthode d’AMF afin que l’utilisateur puisse choisir un autre facteur d’authentification.

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

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

verify · Promise<void>

Cette méthode lance la vérification avec l’authentificateur de plateforme afin de compléter la vérification d’AMF.

Example

import { useMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-platform-challenge';

function VerifyButton() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Platform Authenticator
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

VerifyPlatformAuthenticatorOptions.

rememberDevice · boolean

Facultatif. Si la valeur est true, tente de mémoriser le navigateur pour de futures vérifications d’AMF. Correspond au champ de formulaire rememberBrowser. Cela s’applique uniquement si screen.showRememberDevice est true.

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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