PasskeyEnrollmentLocal

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

La classe PasskeyEnrollmentLocal prend en charge les fonctionnalités de l’écran passkey-enrollment-local. Cet écran permet aux utilisateurs d’inscrire une clé d’accès stockée localement sur leur appareil comme méthode d’authentification.

​

Constructeurs

Créez une instance du gestionnaire de l’écran PasskeyEnrollmentLocal :

Example

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

​

Propriétés

branding · BrandingMembers

Fournit la configuration liée à l’image de marque, comme le thème et les paramètres associés.

client · ClientMembers

Fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran passkey-enrollment-local.

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

Contient les détails propres à l’écran passkey-enrollment-local, 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-local, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme la saisie de l’utilisateur pendant le flux d’inscription de la clé d’accès.

user · UserMembers

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 clé d’accès.

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
await passkeyEnrollmentLocalManager.abortPasskeyEnrollment({ doNotShowAgain: true });

Paramètres de la méthode

Afficher Paramètres

options

AbortEnrollmentOptions.

doNotShowAgain? · boolean

Lorsqu’elle est définie sur true, cette option masque l’invite d’inscription de clé d’accès pour les sessions futures.

changeLanguage · Promise<void>

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

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
passkeyEnrollmentLocalManager.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’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

continuePasskeyEnrollment · Promise<void>

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

Example

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

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.