MfaWebAuthnPlatformEnrollment

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

La classe MfaWebAuthnPlatformEnrollment implémente le fonctionnement de l’écran mfa-webauthn-platform-enrollment. Cet écran s’affiche lorsque l’utilisateur doit inscrire un authentificateur intégré à l’appareil, comme Touch ID ou Face ID.

​

Constructeurs

Créez une instance du gestionnaire de l’écran d’inscription à la plateforme WebAuthn pour MFA :

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-webauthn-platform-enrollment.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnPlatformEnrollment

Contient des détails propres à l’écran mfa-webauthn-platform-enrollment, 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 mfa-webauthn-platform-enrollment, 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 utilisateur lors de l’inscription à MFA sur la plateforme WebAuthn.

user · UserMembers

Contient les 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 MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
mfaWebAuthnPlatformEnrollment.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’il est défini 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.

refuseEnrollmentOnThisDevice · Promise<void>

Cette méthode permet à l’utilisateur de refuser l’inscription à WebAuthn sur l’appareil actuel.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.refuseEnrollmentOnThisDevice();

reportBrowserError · Promise<void>

Cette méthode signale une erreur côté navigateur survenue pendant l’opération WebAuthn navigator.credentials.create().

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.reportBrowserError({
  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 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 survenu.

snoozeEnrollment · Promise<void>

Cette méthode permet à l’utilisateur de reporter l’inscription à WebAuthn.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.snoozeEnrollment();

submitPasskeyCredential · Promise<void>

Cette méthode lance la création des informations d’identification de plateforme WebAuthn et transmet au serveur les informations d’identification obtenues.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();