PasskeyEnrollment

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

La classe PasskeyEnrollment implémente les fonctionnalités de l’écran passkey-enrollment. Cet écran permet aux utilisateurs d’inscrire une clé d’accès en tant que méthode d’authentification.

​

Constructeurs

Créez une instance du gestionnaire d’écran PasskeyEnrollment :

Example

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passkeyEnrollmentManager = new PasskeyEnrollment();
await passkeyEnrollmentManager.continuePasskeyEnrollment();

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran passkey-enrollment.

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 · ScreenMembersOnPasskeyEnrollment

Contient des renseignements propres à l’écran passkey-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 passkey-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 de l’utilisateur pendant le flux d’inscription de la clé d’accès.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

abortPasskeyEnrollment · Promise<void>

Cette méthode interrompt le processus d’inscription de la clé d’accès.

Example

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passkeyEnrollmentManager = new PasskeyEnrollment();
await passkeyEnrollmentManager.abortPasskeyEnrollment();

Paramètres de la méthode

Afficher Paramètres

options

AbortEnrollmentOptions.

doNotShowAgain? · boolean

Lorsqu’elle est définie sur true, masque l’invite d’inscription de la clé d’accès lors des prochaines sessions.

changeLanguage · Promise<void>

Cette méthode modifie la langue d’affichage de la page Universal Login.

Example

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passkeyEnrollmentManager = new PasskeyEnrollment();
passkeyEnrollmentManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (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 durée de la session.

continuePasskeyEnrollment · Promise<void>

Cette méthode continue le processus d’inscription de la clé d’accès.

Example

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passkeyEnrollmentManager = new PasskeyEnrollment();
await passkeyEnrollmentManager.continuePasskeyEnrollment();

getErrors · Error []

Cette méthode renvoie le tableau des erreurs de la transaction présentes dans le contexte, ou un tableau vide s’il n’y en a aucune.