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 met en œuvre la fonctionnalité 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é portable (comme une clé USB FIDO2) dans le cadre de l’étape d’AMF lors d’un processus de réinitialisation du mot de passe.

​

Constructeurs

Créez une instance du gestionnaire de l’é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 et les paramètres de marque.

client · ClientMembers

Fournit des configurations liées 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 l’invite actuelle 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 les entrées de l’utilisateur pendant le flux de défi 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 change 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"

Lorsque cette option 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 le tableau des erreurs de transaction dans le contexte, 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 par l’utilisateur (NotAllowedError) ou l’expiration du délai 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 provenant de l’API WebAuthn (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 true, conserve la préférence « se souvenir de l’appareil » avec le rapport d’erreur.

tryAnotherMethod · Promise<void>

Cette méthode permet à l’utilisateur de sélectionner une autre méthode AMF pour compléter 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 true, conserve la préférence « se souvenir de l’appareil » lors du changement de méthode.

useSecurityKey · Promise<void>

Cette méthode lance la demande d’authentification par clé de sécurité WebAuthn et soumet les informations d’identification obtenues pour terminer l’étape d’AMF durant le processus 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 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 true, l’appareil est marqué comme fiable afin que l’utilisateur n’ait plus à effectuer l’AMF sur cet appareil.