ResetPasswordMfaWebauthnPlatformChallenge

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

L’écran reset-password-mfa-webauthn-platform-challenge s’affiche dans le cadre du processus de réinitialisation du mot de passe, lorsque l’authentification multifacteur au moyen d’une clé d’accès de plateforme est requise. Il invite l’utilisateur à s’authentifier avec la clé d’accès stockée sur son appareil afin de poursuivre la réinitialisation.

​

Importation

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

• L’utilisation de l’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’utilisation de l’importation à la racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous voulez une version unifiée capable de gérer tous les écrans possibles.

Import Example

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

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

function ResetPasswordMfaWebAuthnPlatformChallengeScreen() {
  const { continueWithPasskey } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => continueWithPasskey()}>
      Authenticate with Passkey
    </button>
  );
}

​

Context Hooks

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-platform-challenge. Importez-les depuis @auth0/auth0-acul-react/reset-password-mfa-webauthn-platform-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-platform-challenge.

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-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 reset-password-mfa-webauthn-platform-challenge.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organization de l’utilisateur si la réinitialisation du mot de passe est limitée à l’Organization. Retourne null lorsqu’aucun contexte d’Organization n’est présent.

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge

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

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-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 métadonnées associées.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

Ce hook fournit les détails de 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-platform-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaWebAuthnPlatformChallenge · ResetPasswordMfaWebAuthnPlatformChallengeMembers

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

​

Méthodes

continueWithPasskey · Promise<void>

Cette méthode lance la vérification par clé d’accès de plateforme pour poursuivre l’AMF dans le flux de réinitialisation du mot de passe.

Example

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

function ContinueWithPasskeyButton() {
  const { continueWithPasskey } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => continueWithPasskey()}>
      Authenticate with Passkey
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.

rememberDevice? · boolean

Si true et que screen.showRememberDevice est aussi true, ignore l’AMF lors des connexions suivantes à partir du navigateur actuel.

reportBrowserError · Promise<void>

Cette méthode signale à Auth0 une erreur de navigateur WebAuthn lorsque la vérification par clé d’accès échoue sur l’appareil de l’utilisateur.

Example

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

function HandlePasskeyError() {
  const { reportBrowserError } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => reportBrowserError({ error: { name: 'NotAllowedError', message: 'User cancelled' } })}>
      Report Error
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur provenant 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 redirige l’utilisateur pour qu’il sélectionne une autre méthode d’AMF.

Example

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

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

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant 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 lit et gère les erreurs serveur, client et développeur affichées à l’écran.