ResetPasswordMfaWebAuthnPlatformChallenge

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran reset-password-mfa-webauthn-platform-challenge d’Universal Login.

La classe ResetPasswordMfaWebAuthnPlatformChallenge implémente la fonctionnalité de l’écran reset-password-mfa-webauthn-platform-challenge. Cet écran invite l’utilisateur à vérifier son identité à l’aide d’un authentificateur de plateforme (comme Touch ID ou Windows Hello) dans le cadre de l’étape MFA lors d’un flux de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire d’écran ResetPasswordMfaWebAuthnPlatformChallenge :

Example

import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.continueWithPasskey({
  rememberDevice: true,
});

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème et ses paramètres.

client · ClientMembers

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

organization · OrganizationMembers

Fournit des renseignements sur l’Organisation de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur l’invite actuelle dans le flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge

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

tenant · TenantMembers

Contient des données liées au locataire, comme id et les métadonnées associées.

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran reset-password-mfa-webauthn-platform-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant le flux de défi MFA.

user · UserMembers

Détails de l’utilisateur actif, notamment username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
resetPasswordMfaWebAuthnPlatformChallengeManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

continueWithPasskey · Promise<void>

Cette méthode lance le défi de l’authentificateur de plateforme WebAuthn et soumet les informations d’identification obtenues pour terminer l’étape MFA du flux de réinitialisation du mot de passe. Si le navigateur génère une DOMException (par exemple, si l’utilisateur annule l’opération), interceptez l’erreur et appelez reportBrowserError pour en informer Auth0.

Example

import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
try {
  await resetPasswordMfaWebAuthnPlatformChallengeManager.continueWithPasskey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnPlatformChallengeManager.reportBrowserError({
      error: { name: error.name, message: error.message },
    });
  }
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.

rememberDevice? · boolean

Lorsque true, l’appareil est marqué comme fiable afin que l’utilisateur n’ait pas à refaire la MFA sur cet appareil.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.

reportBrowserError · Promise<void>

Cette méthode signale à Auth0 une erreur WebAuthn côté navigateur, comme une annulation par l’utilisateur (NotAllowedError) ou un délai d’expiration provenant de navigator.credentials.get().

Example

import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.reportBrowserError({
  error: { name: error.name, message: error.message },
});

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requis

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

name · string · requis

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

message · string · requis

Le message d’erreur décrivant ce qui a échoué.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode MFA pour terminer le défi.

Example

import ResetPasswordMfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-platform-challenge';
const resetPasswordMfaWebAuthnPlatformChallengeManager = new ResetPasswordMfaWebAuthnPlatformChallenge();
await resetPasswordMfaWebAuthnPlatformChallengeManager.tryAnotherMethod();