Auditoría
Registro de eventos de la institución, con estadísticas y exportación.
Lista eventos de auditoría de la institución
GET /auditoria
Acceso: Exige la capacidad ADMINISTRAR, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
acao | string | no | ^[a-z][a-z0-9_.]{0,59}$ | Filtra por el tipo de evento (p. ej.: presenca.confirmada). |
instituicaoId | string (uuid) | no | Id de la institución. | |
atorId | string (uuid) | no | Filtra por los eventos hechos por esta persona. | |
fuso | string | no | 1–64 caracteres | Zona horaria IANA para agrupar por día (p. ej.: America/Sao_Paulo). |
cursor | string | no | a 200 caracteres; ^[A-Za-z0-9_-]+$ | Cursor devuelto por la página anterior. |
limite | integer | no | 1…100; por defecto: 50 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de AuditoriaItem | sí | ||
proximo | string o nulo | sí |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/auditoria" -H "Authorization: Bearer $TOKEN"Estadísticas de los eventos de auditoría
GET /auditoria/estatisticas
Acceso: Exige la capacidad ADMINISTRAR, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
acao | string | no | ^[a-z][a-z0-9_.]{0,59}$ | Filtra por el tipo de evento (p. ej.: presenca.confirmada). |
instituicaoId | string (uuid) | no | Id de la institución. | |
atorId | string (uuid) | no | Filtra por los eventos hechos por esta persona. | |
fuso | string | no | 1–64 caracteres | Zona horaria IANA para agrupar por día (p. ej.: America/Sao_Paulo). |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | Data | sí | ||
ate | Data | sí | ||
total | integer | sí | 0… | |
porAcao | lista de object | sí | ||
porAcao[].acao | string | sí | ||
porAcao[].total | integer | sí | 0… | |
porDia | lista de object | sí | ||
porDia[].dia | Data | sí | ||
porDia[].total | integer | sí | 0… |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/auditoria/estatisticas" -H "Authorization: Bearer $TOKEN"Exporta la auditoría en CSV
GET /auditoria/exportar
Acceso: Exige la capacidad ADMINISTRAR, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Límite: hasta 10 llamadas cada 60 s por origen. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
acao | string | no | ^[a-z][a-z0-9_.]{0,59}$ | Filtra por el tipo de evento (p. ej.: presenca.confirmada). |
instituicaoId | string (uuid) | no | Id de la institución. | |
atorId | string (uuid) | no | Filtra por los eventos hechos por esta persona. | |
fuso | string | no | 1–64 caracteres | Zona horaria IANA para agrupar por día (p. ej.: America/Sao_Paulo). |
Respuesta
Archivo CSV (text/csv).
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/auditoria/exportar" -H "Authorization: Bearer $TOKEN"