MfaWebAuthnPlatformEnrollment

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

La classe MfaWebAuthnPlatformEnrollment implémente la fonctionnalité de l’écran mfa-webauthn-platform-enrollment. Cet écran s’affiche lorsque l’utilisateur doit enregistrer un authentificateur de plateforme, comme Touch ID ou Face ID.

​

Constructeurs

Créez une instance du gestionnaire de l’écran MFA WebAuthn Platform Enrollment :

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 de l’image de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran mfa-webauthn-platform-enrollment.

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 · 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 tenant, 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 données saisies par l’utilisateur pendant l’inscription AMF à WebAuthn de plateforme.

user · UserMembers

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

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change 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ètre régional de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

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.

refuseEnrollmentOnThisDevice · Promise<void>

Cette méthode permet à l’utilisateur de refuser l’inscription à WebAuthn de plateforme sur l’appareil en cours d’utilisation.

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.

snoozeEnrollment · Promise<void>

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

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 d’une clé d’accès WebAuthn de plateforme et envoie l’information d’identification obtenue au serveur.

Example

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

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