Modelos de datos
Los modelos corresponden a los schemas de la especificación OpenAPI. Pueden aparecer campos no listados según el entorno; ignore los campos que su integración no conoce.
OperationResponse
Envoltorio común de las respuestas de operación.
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | Resultado de la operación. 0 indica éxito. |
description | string | Descripción del resultado devuelta por la API. |
apiver | string | Versión de la API y del producto, en el formato v2 (9.0.1). |
user | string | Usuario de la operación. |
length | integer (int64) | Tamaño, en bytes, cuando corresponde. |
time | string | Fecha y hora de la respuesta en formato ISO 8601 (RFC 3339), con la zona horaria del servidor, por ejemplo 2026-11-07T14:03:21-03:00. En la API v1, el campo usaba el formato 2026-11-07 14:03:21.123456789 -0300 -03. |
LoginResponse
Respuesta 200 de /auth/login.
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | 0 en caso de éxito. |
description | string | Descripción del resultado. |
apiver | string | Versión de la API y del producto, en el formato v2 (9.0.1). |
user | string | Usuario autenticado. |
urllink | string (URI) | Enlace de acceso al portal. |
time | string | Fecha y hora de la respuesta en formato ISO 8601 (RFC 3339), con la zona horaria del servidor, por ejemplo 2026-11-07T14:03:21-03:00. En la API v1, el campo usaba el formato 2026-11-07 14:03:21.123456789 -0300 -03. |
El token de sesión no forma parte del JSON; se envía en la cookie __Host-dirl_session.
MfaChallengeResponse
Respuesta 206 de /auth/login cuando se requiere MFA.
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | Etapa del MFA: 1 PIN por correo electrónico o SMS, 2 TOTP registrado, 3 registro del TOTP. |
description | string | Descripción del desafío. |
apiver | string | Versión de la API y del producto, en el formato v2 (9.0.1). |
user | string | Usuario. |
linkURL | string (URI) | URL segura completa: /auth/mfa (status 1 y 2) o /auth/mfa/register (status 3). |
secret | string | Status 3: secreto TOTP en Base32. Vacío en el status 2; ausente en el status 1. Dato sensible. |
qrcode | string | Status 3: código QR del secreto, imagen PNG de 200 × 200 en Base64 URL-safe. Vacío en el status 2; ausente en el status 1. |
time | string | Fecha y hora de la respuesta en formato ISO 8601 (RFC 3339), con la zona horaria del servidor, por ejemplo 2026-11-07T14:03:21-03:00. En la API v1, el campo usaba el formato 2026-11-07 14:03:21.123456789 -0300 -03. |
MfaRegisterResponse
Respuesta 200 de /auth/mfa/register. No establece sesión.
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | 0 en caso de éxito. |
description | string | Descripción del resultado. |
apiver | string | Versión de la API y del producto, en el formato v2 (9.0.1). |
user | string | Usuario. |
length | integer | Siempre 0. |
time | string | Fecha y hora de la respuesta. |
SecureLinkResponse
Respuesta de /auth/firstaccess y /auth/forget.
| Campo | Tipo | Descripción |
|---|---|---|
status | integer | 0 en caso de éxito. |
description | string | Descripción del resultado. |
apiver | string | Versión de la API y del producto, en el formato v2 (9.0.1). |
user | string | Usuario. |
linkURL | string (URI) | Enlace seguro enviado al usuario. |
time | string | Fecha y hora de la respuesta en formato ISO 8601 (RFC 3339), con la zona horaria del servidor, por ejemplo 2026-11-07T14:03:21-03:00. En la API v1, el campo usaba el formato 2026-11-07 14:03:21.123456789 -0300 -03. |
TokenResponse
Respuesta 200 de /auth/token y /oauth2/token. Todos los campos se devuelven siempre.
| Campo | Tipo | Descripción |
|---|---|---|
access_token | string | Token de acceso. |
issued_token_type | string | urn:ietf:params:oauth:token-type:access_token. |
token_type | string | Bearer. |
expires_in | integer (int64) | Validez del token, en segundos. Varía según el entorno. |
scope | string | URI de la API configurada. No representa una lista de permisos. |
OAuthError
Respuesta 400 de /auth/token y /oauth2/token.
| Campo | Tipo | Descripción |
|---|---|---|
error | integer | Código numérico de la condición informada por la validación. |
error_description | string | Motivo del error. |
error_uri | string (URI) | URI de la API. |
UploadResponse
Respuesta 200 de /upload. Incluye los campos de OperationResponse y:
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Nombre o identificador del archivo recibido. |
destination | string | Destino de la transferencia. |
length | integer (int64) | Tamaño recibido, en bytes. |
linkURL | array de string (URI) | Enlaces de notificación generados, si los hay. |
FileListResponse
Respuesta 200 de /download/list y /download/list/backup. Incluye los campos de OperationResponse y:
| Campo | Tipo | Descripción |
|---|---|---|
files | array de FileEntry | Archivos de la página. Puede estar vacío. |
page_next | string | Índice de la página siguiente. |
FileEntry
| Campo | Tipo | Descripción |
|---|---|---|
id | integer | Identificador del archivo en el listado. |
name | string | Nombre del archivo. |
length | integer (int64) | Tamaño, en bytes. |
modified | integer (int64) | Fecha de modificación, en milisegundos desde 1970-01-01 UTC. |
linkURL | string (URI) | Enlace firmado para la descarga. Use la URL completa. |
DownloadPinResponse
Respuesta 200 de /download/pin. Incluye los campos de OperationResponse y:
| Campo | Tipo | Descripción |
|---|---|---|
email | string | Correo electrónico del destinatario. |
phone | string | Teléfono del destinatario. |
file | string | Nombre del archivo. |
linkURL | string (URI) | Enlace seguro para la descarga. |
ReportResponse
Respuesta 200 de /report. Incluye los campos de OperationResponse y:
| Campo | Tipo | Descripción |
|---|---|---|
page | integer | Página devuelta. |
logs | array de objetos | Registros de transferencia de la consulta. |