MfaWebauthnError

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

L’écran mfa-webauthn-error affiche une erreur survenue lors d’une tentative d’authentification WebAuthn et propose à l’utilisateur des options pour récupérer ou essayer une autre méthode.

​

Importation

Chaque écran a 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 lot, ce qui est utile si vous voulez une version unifiée capable de gérer tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaWebAuthnError,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  noThanks,
  tryAgain,
  tryAnotherMethod,
  usePassword,
} from "@auth0/auth0-acul-react/mfa-webauthn-error";

function MfaWebAuthnErrorScreen() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Try Again
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

Ce hook fournit des configurations de l’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran mfa-webauthn-error.

Example

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

Example

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnError

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

Example

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

useTenant · () => 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-webauthn-error';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook fournit 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-error';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des détails 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-webauthn-error';
function UserProfile() {
  const user = useUser();
}

useMfaWebAuthnError · MfaWebAuthnErrorMembers

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

​

Méthodes

noThanks · Promise<void>

Cette méthode supprime l’erreur WebAuthn et annule le flux d’AMF en cours.

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function NoThanksButton() {
  const { noThanks } = useMfaWebAuthnError();
  return (
    <button onClick={() => noThanks()}>
      Non merci
    </button>
  );
}

tryAgain · Promise<void>

Cette méthode relance l’authentification WebAuthn après une erreur.

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function TryAgainButton() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Réessayer
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

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

usePassword · Promise<void>

Cette méthode modifie le flux d’authentification pour utiliser un mot de passe au lieu de WebAuthn.

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function UsePasswordButton() {
  const { usePassword } = useMfaWebAuthnError();
  return (
    <button onClick={() => usePassword()}>
      Utiliser plutôt le mot de passe
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook permet d’obtenir les options du thème actuel avec une configuration à plat à partir du contexte d’image de marque.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

Ce hook permet d’obtenir le contexte de l’écran actuel et son état.

useErrors · Hooks

Ce hook lit et gère les erreurs serveur, client et développeur affichées à l’écran.