PasskeyEnrollment

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

La clase PasskeyEnrollment implementa la funcionalidad de la pantalla passkey-enrollment. Esta pantalla permite que los usuarios inscriban una passkey como método de autenticación.

​

Constructores

Cree una instancia del administrador de la pantalla PasskeyEnrollment:

Example

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

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y los ajustes de marca.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla passkey-enrollment.

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

Contiene detalles específicos de la pantalla passkey-enrollment, 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, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Contiene datos no confiables que se pasan al SDK, como la entrada del usuario durante el flujo de inscripción de passkey.

user · UserMembers

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

​

Métodos

abortPasskeyEnrollment · Promise<void>

Este método cancela el proceso de inscripción de passkey.

Example

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

Parámetros del método

Mostrar Parámetros

options

AbortEnrollmentOptions.

doNotShowAgain? · boolean

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

changeLanguage · Promise<void>

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

Example

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

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

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

persist? · "session"

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

continuePasskeyEnrollment · Promise<void>

Este método continúa el proceso de inscripción de passkey.

Example

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

getErrors · Error []

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