MfaWebAuthnRoamingEnrollment

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran mfa-webauthn-roaming-enrollment de la fonctionnalité Universal Login.

La classe MfaWebAuthnRoamingEnrollment implémente la fonctionnalité de l’écran mfa-webauthn-roaming-enrollment. Cet écran s’affiche lorsqu’un utilisateur doit enregistrer un authentificateur WebAuthn itinérant, par exemple : une clé de sécurité.

​

Constructeurs

Créez une instance du gestionnaire d’écran d’inscription itinérante WebAuthn MFA :

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des paramètres liés au client, comme id, name et logoUrl, pour l’écran mfa-webauthn-roaming-enrollment.

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur l’étape actuelle du flux d’authentification.

screen · ScreenMembersOnMfaWebAuthnRoamingEnrollment

Contient des détails propres à l’écran mfa-webauthn-roaming-enrollment, y compris 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 mfa-webauthn-roaming-enrollment, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant l’inscription itinérante à MFA WebAuthn.

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 MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
mfaWebAuthnRoamingEnrollment.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.

enroll · Promise<void>

Cette méthode lance la création des identifiants WebAuthn et en transmet le résultat au serveur.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

getErrors · Error []

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

showError · Promise<void>

Cette méthode transmet au serveur les détails d’une erreur du navigateur liée à WebAuthn.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.showError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur provenant de l’API WebAuthn (navigator.credentials.create()) à 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 permet à l’utilisateur d’essayer une autre méthode MFA.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.tryAnotherMethod();