MfaWebAuthnPlatformEnrollment

Describe todas las propiedades y los métodos disponibles para personalizar la pantalla mfa-webauthn-platform-enrollment de Universal Login.

La clase MfaWebAuthnPlatformEnrollment implementa la funcionalidad de la pantalla mfa-webauthn-platform-enrollment. Esta pantalla se muestra cuando el usuario necesita realizar la inscripción de un autenticador de plataforma, como Touch ID o Face ID.

​

Constructores

Crea una instancia del administrador de la pantalla de inscripción en plataforma WebAuthn de MFA:

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-webauthn-platform-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 · ScreenMembersOnMfaWebAuthnPlatformEnrollment

Contiene detalles específicos de la pantalla mfa-webauthn-platform-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 mfa-webauthn-platform-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 la inscripción en plataforma WebAuthn de MFA.

user · UserMembers

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

​

Métodos

changeLanguage · Promise<void>

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

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

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

Si se establece en 'session', el idioma seleccionado se conserva durante la sesión.

getErrors · Error []

Este método recupera la matriz de errores de la transacción del contexto, o una matriz vacía si no hay ninguno.

refuseEnrollmentOnThisDevice · Promise<void>

Este método permite al usuario rechazar la inscripción en plataforma WebAuthn en este dispositivo.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.refuseEnrollmentOnThisDevice();

reportBrowserError · Promise<void>

Este método informa un error del navegador detectado durante la operación navigator.credentials.create() de WebAuthn.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

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

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

error · WebAuthnErrorDetails · requerido

El objeto de error de la API de WebAuthn (navigator.credentials.create()) que se debe informar.

name · string · requerido

El nombre del error (por ejemplo, 'NotAllowedError').

message · string · requerido

El mensaje de error que describe el problema.

snoozeEnrollment · Promise<void>

Este método permite al usuario posponer la inscripción en plataforma WebAuthn.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.snoozeEnrollment();

submitPasskeyCredential · Promise<void>

Este método inicia la creación de la credencial de plataforma de WebAuthn y envía al servidor la credencial de clave de acceso resultante.

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();