MfaPhoneChallenge

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

La clase MfaPhoneChallenge implementa la funcionalidad de la pantalla mfa-phone-challenge. Esta pantalla se muestra cuando el usuario necesita recibir un código para verificar su identidad.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío telefónico de MFA:

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones de marca, como el tema y sus ajustes.

client · ClientMembers

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

Contiene detalles específicos de la pantalla mfa-phone-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-phone-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 MFA por teléfono.

user · UserMembers

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

​

Métodos

changeLanguage · Promise<void>

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

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
mfaPhoneChallenge.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 como 'session', el idioma seleccionado se conserva durante toda la sesión.

continue · Promise<void>

Este método envía la elección del usuario de recibir el código de MFA por SMS o mediante una llamada de voz.

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

Parámetros del método

Mostrar Parámetros

options

MfaPhoneChallengeContinueOptions.

type · "sms" | "voice" · requerido

El método de entrega del código de MFA.

getErrors · Error []

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

pickPhone · Promise<void>

Este método inicia el proceso para que el usuario seleccione un número de teléfono diferente.

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.pickPhone();

tryAnotherMethod · Promise<void>

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

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.tryAnotherMethod();