PasskeyEnrollmentLocal

Describe todas las propiedades y métodos disponibles para personalizar la pantalla passkey-enrollment-local de Universal Login.

La clase PasskeyEnrollmentLocal implementa la funcionalidad de la pantalla passkey-enrollment-local. Esta pantalla permite que los usuarios inscriban una clave de acceso almacenada localmente en su dispositivo como método de autenticación.

​

Constructores

Cree una instancia del administrador de la pantalla PasskeyEnrollmentLocal:

Example

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

​

Propiedades

branding · BrandingMembers

Proporciona la configuración de marca, como el tema y otros ajustes.

client · ClientMembers

Proporciona la configuración del cliente, como id, name y logoUrl, para la pantalla passkey-enrollment-local.

organization · OrganizationMembers

Proporciona información sobre la Organización del usuario, como id y name.

prompt · PromptMembers

Contiene datos sobre la pantalla actual del flujo de autenticación.

screen · ScreenMembersOnPasskeyEnrollmentLocal

Contiene detalles específicos de la pantalla passkey-enrollment-local, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla passkey-enrollment-local, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Contiene datos no confiables pasados al SDK, como entradas del usuario durante el flujo de inscripción de clave de acceso.

user · UserMembers

Detalles del usuario activo, incluidos username, email y roles.

​

Métodos

abortPasskeyEnrollment · Promise<void>

Este método aborta el proceso de inscripción de clave de acceso.

Example

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

Parámetros del método

Mostrar Parámetros

options

AbortEnrollmentOptions.

doNotShowAgain? · boolean

Cuando se establece en true, oculta la pantalla de inscripción de clave de acceso en futuras sesiones.

changeLanguage · Promise<void>

Este método cambia el idioma que se muestra en la página de Universal Login.

Example

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

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

El código de idioma o configuración regional deseado (por ejemplo, 'en', 'fr', 'es').

persist? · "session"

Cuando se establece en 'session', el idioma seleccionado se mantiene durante la sesión.

continuePasskeyEnrollment · Promise<void>

Este método continúa con el proceso de inscripción de clave de acceso.

Example

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

getErrors · Error []

Este método recupera el array de errores de la transacción del contexto, o un array vacío si no hay ninguno.