MfaWebAuthnPlatformChallenge

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

La classe MfaWebAuthnPlatformChallenge implémente les fonctionnalités de l’écran mfa-webauthn-platform-challenge. Cet écran s’affiche lorsque l’utilisateur doit vérifier son identité au moyen d’un authentificateur de plateforme, comme Touch ID ou Face ID.

​

Constructeurs

Créez une instance du gestionnaire d’écran MFA WebAuthn Platform Challenge :

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran mfa-webauthn-platform-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 en cours dans le flux d’authentification.

screen · ScreenMembersOnMfaWebAuthnPlatformChallenge

Contient des détails propres à l’écran mfa-webauthn-platform-challenge, 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-challenge, comme les identifiants actifs et l’état du flux.

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les entrées utilisateur pendant le défi de plateforme MFA WebAuthn.

user · UserMembers

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 MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
mfaWebAuthnPlatformChallenge.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"

Lorsque la valeur est définie à 'session', la langue sélectionnée est conservée pendant toute 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.

reportBrowserError · Promise<void>

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.reportBrowserError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

Paramètres de la méthode

Afficher Paramètres

options

MfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requis

L’objet d’erreur de l’API WebAuthn (navigator.credentials.get()) à signaler.

name · string · requis

Le nom de l’erreur (par 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 MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.tryAnotherMethod();

verify · Promise<void>

Cette méthode lance le défi de l’authentificateur de plateforme WebAuthn.

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

Paramètres de la méthode

Afficher Paramètres

options

CustomOptions.

rememberDevice? · boolean

Lorsque true, le navigateur est mémorisé pour les prochains défis MFA. S’applique uniquement si screen.showRememberDevice a la valeur true.