MfaWebAuthnPlatformChallenge

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

La clase MfaWebAuthnPlatformChallenge implementa la funcionalidad de la pantalla mfa-webauthn-platform-challenge. Esta pantalla se muestra cuando el usuario debe verificar su identidad con un autenticador de plataforma, como Touch ID o Face ID.

​

Constructores

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones 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-platform-challenge.

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

Contiene detalles específicos de la pantalla mfa-webauthn-platform-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-platform-challenge, 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 desafío de 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 de visualización de la página de Universal Login.

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
mfaWebAuthnPlatformChallenge.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 toda la sesión.

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.

reportBrowserError · Promise<void>

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

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

Parámetros del método

Mostrar Parámetros

options

MfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · requerido

El objeto de error de la API de WebAuthn (navigator.credentials.get()) 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.

tryAnotherMethod · Promise<void>

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.tryAnotherMethod();

verify · Promise<void>

Este método inicia el desafío del autenticador de plataforma de WebAuthn.

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

rememberDevice? · boolean

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