MfaWebAuthnRoamingEnrollment

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

La clase MfaWebAuthnRoamingEnrollment implementa la funcionalidad de la pantalla mfa-webauthn-roaming-enrollment. Esta pantalla se muestra cuando un usuario necesita inscribirse en un autenticador de itinerancia WebAuthn, por ejemplo, una clave de seguridad.

​

Constructores

Cree una instancia del gestor de la pantalla de inscripción de MFA WebAuthn de itinerancia:

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-webauthn-roaming-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 · ScreenMembersOnMfaWebAuthnRoamingEnrollment

Contiene detalles específicos de la pantalla mfa-webauthn-roaming-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-roaming-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 MFA con WebAuthn de itinerancia.

user · UserMembers

Contiene 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 MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
mfaWebAuthnRoamingEnrollment.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.

enroll · Promise<void>

Este método inicia la creación de credenciales de WebAuthn y envía el resultado al servidor.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

getErrors · Error []

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

showError · Promise<void>

Este método envía al servidor los detalles de un error del navegador relacionado con WebAuthn.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.showError({
  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 lo ocurrido.

tryAnotherMethod · Promise<void>

Este método permite al usuario intentar otro método de MFA.

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.tryAnotherMethod();