LoginPasswordlessSmsOtp

La clase LoginPasswordlessSmsOtp implementa la funcionalidad de la pantalla login-passwordless-sms-otp. Esta pantalla recopila el número de teléfono y el code del usuario.

Constructores

Cree una instancia del administrador de la pantalla LoginPasswordlessSmsOtp:

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

Propiedades

BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y los ajustes.

ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla login-passwordless-sms-otp.

OrganizationMembers

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

PromptMembers

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

ScreenMembersOnLoginPasswordlessSmsOtp

Contiene detalles específicos de la pantalla login-passwordless-sms-otp, incluida su configuración y contexto.

TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

TransactionMembersOnLoginPasswordlessSmsOtp

Proporciona datos específicos de la transacción para la pantalla login-passwordless-sms-otp, como identificadores activos y estados del flujo.

UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como la entrada del usuario durante el inicio de sesión.

UserMembers

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

Métodos

Promise<void>

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.changeLanguage({
  language: 'fr',
});

Parámetros del método

Mostrar Parámetros

LanguageChangeOptions.

string

requerido

El código de configuración regional del idioma deseado (por ejemplo, 'en', 'fr', 'es').

"session"

Cuando se establece en 'session', el idioma seleccionado se conserva durante toda la sesión.

"string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

Error[]

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

ResendControl

Este método proporciona funcionalidad de reenvío con control del tiempo de espera. Devuelve un objeto ResendControl con un método startResend() que activa el reenvío y aplica un período de espera antes de que el usuario pueda volver a reenviar.

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';

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

// Llama a startResend cuando el usuario haga clic en el botón de reenvío
startResend();

Parámetros del método

Mostrar Parámetros

StartResendOptions.

number

La duración del período de espera, en segundos, antes de que el usuario pueda reenviar el code de nuevo.

OnStatusChangeCallback

Callback que se invoca cada vez que cambia el estado del reenvío; devuelve los segundos restantes y si la funcionalidad de reenvío está deshabilitada en ese momento.

() => void

Callback que se invoca cuando vence el período de espera y el reenvío vuelve a estar disponible.

Promise<void>

Este método reenvía el code al número de teléfono del usuario.

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.resendOTP();

Parámetros del método

Mostrar Parámetros

CustomOptions.

"string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

Promise<void>

Este método continúa el proceso de inicio de sesión con el code OTP.

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

Parámetros del método

Mostrar Parámetros

SubmitOTPOptions.

string

requerido

El code introducido por el usuario.

string

El code captcha o la respuesta del proveedor de captcha. Esta propiedad es obligatoria si tu inquilino de Auth0 tiene habilitada la detección de bots.

string

El identificador del usuario.

"string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

Promise<void>

Este método alterna entre una conexión de base de datos (contraseña) y una conexión sin contraseña (correo electrónico/SMS OTP).

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.switchConnection({
  connection: 'sms',
});

Parámetros del método

Mostrar Parámetros

SwitchConnectionOptionsSmsOtp.

string

requerido

El nombre de la conexión a la que se cambiará. Usa 'email' o 'sms' para autenticación sin contraseña, o un nombre de conexión de base de datos para autenticación basada en contraseña.

"string" | "number" | "boolean"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

​Constructores

​Propiedades

​Métodos

Constructores

Propiedades

Métodos