MfaWebauthnRoamingChallenge

Décrit tous les hooks et toutes les méthodes offerts pour personnaliser l’écran mfa-webauthn-roaming-challenge d’Universal Login.

L’écran mfa-webauthn-roaming-challenge demande à l’utilisateur de répondre à un défi d’AMF à l’aide d’une clé de sécurité itinérante, comme une YubiKey ou un autre authentificateur matériel FIDO2.

​

Importation

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

• Avec l’importation partielle, vous pouvez inclure uniquement le code nécessaire à votre cas d’usage.
• Avec l’importation depuis la racine, vous pouvez charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une compilation unifiée prenne en charge tous les écrans possibles.

Import Example

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

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

function MfaWebAuthnRoamingChallengeScreen() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Security Key
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

Ce hook fournit les paramètres de personnalisation de la marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran mfa-webauthn-roaming-challenge.

Example

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

useClient · () => ClientMembers

Ce hook fournit des paramètres liés au client, comme id, name et logoUrl, pour l’écran mfa-webauthn-roaming-challenge.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite actuelle dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook traite 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-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-roaming-challenge';
function UserProfile() {
  const user = useUser();
}

useMfaWebAuthnRoamingChallenge · MfaWebAuthnRoamingChallengeMembers

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

​

Méthodes

reportWebAuthnError · Promise<void>

Cette méthode signale une erreur WebAuthn survenue lors du test avec une clé de sécurité itinérante.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function HandleWebAuthnError({ error }) {
  const { reportWebAuthnError } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => reportWebAuthnError({ error })}>
      Signaler l’erreur
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur de l’API WebAuthn (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 redirige vers l’écran de sélection de la méthode MFA pour permettre à l’utilisateur de choisir un autre facteur d’authentification.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Essayer une autre méthode
    </button>
  );
}

verify · Promise<void>

Cette méthode lance la vérification de la clé de sécurité itinérante afin de terminer le défi d’AMF.

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function VerifyButton() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Vérifier avec la clé de sécurité
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

VerifySecurityKeyOptions.

rememberDevice · boolean

Facultatif. Si la valeur est true, le navigateur sera mémorisé pour les futurs défis d’AMF. Correspond au champ de formulaire rememberBrowser.

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options de thème actuelles avec une configuration aplatie à partir du contexte 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 permet de lire et de gérer les erreurs du serveur, du client et du développeur à l’écran.