ResetPasswordMfaWebAuthnRoamingChallenge

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

La classe ResetPasswordMfaWebAuthnRoamingChallenge implémente les fonctionnalités de l’écran reset-password-mfa-webauthn-roaming-challenge. Cet écran invite l’utilisateur à vérifier son identité à l’aide d’une clé de sécurité itinérante (comme une clé USB FIDO2) au cours de l’étape d’AMF d’un flux de réinitialisation du mot de passe.

​

Constructeurs

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

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations relatives au client, comme id, name et logoUrl, pour l’écran reset-password-mfa-webauthn-roaming-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge

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

tenant · TenantMembers

Contient des données liées au tenant, 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-roaming-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant le flux de vérification AMF.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

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

Example

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

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue correspondant à 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 durée de la session.

getErrors · Error []

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

showError · Promise<void>

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

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
  error: { name: error.name, message: error.message },
});

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur 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.

rememberDevice? · boolean

Lorsque la valeur est true, la préférence de mémorisation de l’appareil est conservée avec le signalement d’erreur.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode d’AMF pour terminer la vérification.

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.tryAnotherMethod();

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.

rememberDevice? · boolean

Lorsque la valeur est true, la préférence de mémorisation de l’appareil est conservée au moment de changer de méthode.

useSecurityKey · Promise<void>

Cette méthode lance le défi par clé de sécurité WebAuthn et soumet les données d’identification obtenues pour terminer l’AMF dans le cadre du flux de réinitialisation du mot de passe. Si le navigateur renvoie une DOMException (par exemple, si l’utilisateur annule l’opération), capturez l’erreur et appelez showError pour en informer Auth0.

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}

Paramètres de la méthode

Afficher Paramètres

options

ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.

rememberDevice? · boolean

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