MfaSmsChallenge

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

La clase MfaSmsChallenge implementa la funcionalidad de la pantalla mfa-sms-challenge. Esta pantalla se muestra cuando el usuario debe introducir un código SMS para verificar su identidad.

​

Constructores

Cree una instancia del administrador de la pantalla de desafío MFA por SMS:

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuraciones del cliente, como id, name y logoUrl, para la pantalla mfa-sms-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 · ScreenMembersOnMfaSmsChallenge

Contiene detalles específicos de la pantalla mfa-sms-challenge, incluida su configuración y su 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-sms-challenge, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembersOnMfaSmsChallenge

Contiene datos no confiables que se pasan al SDK, como la entrada del usuario durante el desafío MFA por SMS.

user · UserMembers

Contiene 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 MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
mfaSmsChallenge.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.

continueMfaSmsChallenge · Promise<void>

Este método envía el desafío de MFA por SMS con el código proporcionado.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

Parámetros del método

Mostrar Parámetros

options

MfaSmsChallengeOptions.

code · string · requerido

El código SMS introducido por el usuario.

rememberDevice? · boolean

Cuando se establece en true, registra este dispositivo como de confianza para que no se solicite MFA al usuario en inicios de sesión posteriores desde el mismo dispositivo.

getACall · Promise<void>

Este método cambia el método de verificación a una llamada de voz.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.getACall();

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.

pickSms · Promise<void>

Este método navega a la pantalla donde el usuario puede elegir un número de SMS diferente.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.pickSms();

resendCode · Promise<void>

Este método reenvía al usuario el código de verificación por SMS.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.resendCode();

resendManager · ResendControl

Este método proporciona la función de reenvío con un tiempo de espera configurable y gestión del estado.

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
const { startResend } = mfaSmsChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  },
});

startResend();

Parámetros del método

Mostrar Parámetros

options

StartResendOptions.

onStatusChange? · OnStatusChangeCallback

Callback que se invoca cada vez que cambia el estado del reenvío y recibe los segundos restantes y si el reenvío está deshabilitado en ese momento.

onTimeout? · () => void

Callback que se invoca cuando vence el tiempo de espera del reenvío y la opción de reenvío vuelve a estar disponible.

timeoutSeconds? · number

Número de segundos que deben transcurrir antes de que la opción de reenvío esté disponible.

tryAnotherMethod · Promise<void>

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

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.tryAnotherMethod();