ResetPasswordMfaWebauthnRoamingChallenge

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran reset-password-mfa-webauthn-roaming-challenge de Universal Login.

L’écran reset-password-mfa-webauthn-roaming-challenge s’affiche pendant le flux de réinitialisation du mot de passe lorsqu’une authentification multifacteur est requise au moyen d’une clé de sécurité itinérante. Il invite l’utilisateur à s’authentifier à l’aide de sa clé de sécurité physique externe pour poursuivre le processus de réinitialisation.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge les imports partiels et les imports racine pour chaque écran.

• Un import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’usage.
• Un import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez un build unifié capable de gérer tous les écrans possibles.

Import Example

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

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

function ResetPasswordMfaWebAuthnRoamingChallengeScreen() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      S’authentifier avec une clé de sécurité
    </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 reset-password-mfa-webauthn-roaming-challenge. Importez-les depuis @auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organisation de l’utilisateur si la réinitialisation du mot de passe s’applique à une Organisation. Renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</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/reset-password-mfa-webauthn-roaming-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge

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

Example

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

useTenant · () => TenantMembers

Ce hook contient des données relatives au locataire, comme id et les métadonnées associées.

Example

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

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran reset-password-mfa-webauthn-roaming-challenge, comme les connexions actives et l’état actuel du flux.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme un courriel ou un nom d’utilisateur prérempli à partir des paramètres d’URL.

Example

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

useResetPasswordMfaWebAuthnRoamingChallenge · ResetPasswordMfaWebAuthnRoamingChallengeMembers

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

​

Méthodes

showError · Promise<void>

Cette méthode signale à Auth0 une erreur du navigateur WebAuthn lorsque le défi de la clé de sécurité échoue sur l’appareil de l’utilisateur.

Example

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

function HandleSecurityKeyError() {
  const { showError } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => showError({ error: { name: 'NotAllowedError', message: 'User cancelled' } })}>
      Signaler l’erreur
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.

rememberDevice? · boolean

Si true et que screen.showRememberDevice est également true, la MFA est ignorée lors des connexions suivantes à partir du navigateur actuel.

error · WebAuthnErrorDetails · requis

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

name · string · requis

Le nom de l’erreur (par exemple, 'NotAllowedError').

message · string · requis

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

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode MFA.

Example

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

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

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.

rememberDevice? · boolean

Si true et que screen.showRememberDevice est également true, la MFA est ignorée lors des connexions suivantes à partir du navigateur actuel.

useSecurityKey · Promise<void>

Cette méthode lance le défi de la clé de sécurité itinérante pour poursuivre l’étape MFA dans le flux de Réinitialisation du mot de passe.

Example

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

function UseSecurityKeyButton() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      S’authentifier avec une clé de sécurité
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.

rememberDevice? · boolean

Si true et que screen.showRememberDevice est également true, la MFA est ignorée lors des connexions suivantes à partir du navigateur actuel.

​

Hooks communs et 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 qui permet de changer 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, de l’application et du développeur sur l’écran.