MfaWebAuthnRoamingChallenge

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

La clase MfaWebAuthnRoamingChallenge implementa la funcionalidad de la pantalla mfa-webauthn-roaming-challenge. Esta pantalla se muestra cuando el usuario debe verificar su identidad con un autenticador de itinerancia, como una clave de seguridad.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío MFA WebAuthn de itinerancia:

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.verify();

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla mfa-webauthn-roaming-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnRoamingChallenge

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

untrustedData · UntrustedDataMembers

Contiene datos no confiables que se pasan al SDK, como entradas del usuario durante el desafío de 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 MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
mfaWebAuthnRoamingChallenge.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 conserva durante la sesión.

getErrors · Error []

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

reportWebAuthnError · Promise<void>

Este método notifica un error de la API de WebAuthn detectado durante la operación navigator.credentials.get().

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.reportWebAuthnError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

Parámetros del método

Mostrar Parámetros

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requerido

El objeto de error de la API de WebAuthn (navigator.credentials.get()) que se debe notificar.

name · string · requerido

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

message · string · requerido

El mensaje de error que describe qué salió mal.

tryAnotherMethod · Promise<void>

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

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.tryAnotherMethod();

verify · Promise<void>

Este método inicia el desafío de WebAuthn con la clave de seguridad.

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.verify();

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

rememberDevice? · boolean

Cuando es true, recuerda este navegador para futuros desafíos de MFA. Solo se aplica si screen.showRememberDevice es true.