Alias de tipo: MfaPollingOptions

MfaPollingOptions · object

Opciones de configuración para gestionar un proceso de sondeo de notificaciones push de MFA.

Proporcione estas opciones al iniciar una sesión de sondeo para controlar con qué frecuencia se consulta el endpoint de desafío y cómo se gestionan los casos de éxito o error.

Example

export type MfaPollingOptions = {
  /**
   * Intervalo opcional, en **milisegundos**, entre solicitudes de sondeo consecutivas.
   *
   * - Si se omite, se usa el intervalo predeterminado interno del SDK (normalmente 5000 ms).
   * - Elija un valor que equilibre la capacidad de respuesta con los límites de tasa.
   *
   * @defaultValue Específico de la implementación (normalmente 5000 ms)
   */
  intervalMs?: number;

  /**
   * Callback opcional que se ejecuta una vez que el desafío push de MFA se aprueba
   * correctamente y el sondeo finaliza.
   *
   * - Se llama exactamente **una vez**, tras lo cual el sondeo se detiene automáticamente.
   * - Útil para avanzar el flujo de inicio de sesión (por ejemplo, llamando a `continue()`).
   */
  onCompleted?: () => void;

  /**
   * Callback opcional que se invoca si se produce un error durante el sondeo.
   *
   * Recibe un objeto {@link ULError} que contiene:
   * - `status` — el código de estado HTTP de la solicitud fallida
   * - `responseText` — el cuerpo de la respuesta sin procesar, si está disponible
   *
   * - Se llama una vez por cada evento de error; el sondeo puede reintentarse según el tipo de error.
   * - Úselo para mostrar mensajes de error o activar lógica personalizada de reintento o cancelación.
   */
  onError?: (error: ULError) => void;
};

Show Propiedades

intervalMs? · number

Intervalo opcional, en milisegundos, entre solicitudes de sondeo consecutivas.

• Si se omite, se usa el intervalo predeterminado interno del SDK (normalmente 5000 ms).
• Elija un valor que equilibre la capacidad de respuesta con los límites de tasa.

Valor predeterminado

Específico de la implementación (normalmente 5000 ms)

onCompleted()? · () => void

Callback opcional que se ejecuta una vez que el desafío push de MFA se aprueba correctamente y el sondeo finaliza.

• Se llama exactamente una vez, tras lo cual el sondeo se detiene automáticamente.
• Útil para avanzar el flujo de inicio de sesión (por ejemplo, llamando a continue()).

onError()? · (error) => void

Callback opcional que se invoca si se produce un error durante el sondeo.

Recibe un objeto ULError que contiene:

• status — el código de estado HTTP de la solicitud fallida

• responseText — el cuerpo de la respuesta sin procesar, si está disponible

• Se llama una vez por cada evento de error; el sondeo puede reintentarse según el tipo de error.

• Úselo para mostrar mensajes de error o activar lógica personalizada de reintento o cancelación.

Propiedades

error · Error

Propiedades

code · string

field? · string

message · string

rules? · PasswordComplexityRule[]