auditlog.get

Descripción

integer/array auditlog.get(parámetros de objeto)

El método permite recuperar registros de auditoría de acuerdo a los parámetros aportados.

Este método solo está disponible para usuarios de tipo Super admin. Los permisos para invocar el método pueden ser revocados en la configuración del rol de usuario. Ver Roles de Usuario para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
auditids string/array Solo devuelve los registros de auditoría con los IDs proporcionados.
userids string/array Solo devuelve los registros de auditoría que fueron creados por los usuarios proporcionados.
time_from timestamp Solo devuelve los registros de auditoría que han sido creados durante o después de la fecha y hora proporcionada.
time_till timestamp Solo devuelve los registros de auditoría que han sido creados durante o antes de la fecha y hora proporcionada.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Los valores posibles son: auditid, userid, clock.
filter object Devuelve solo los resultados que cumplen exactamente el filtro indicado.

Acepta una matriz (array), donde las claves (keys) son nombres de propiedad, y los valores son o un valor único o una matriz de valores con los que comparar.

Además, admite el filtrado por los campos propiedad de los detalles: table_name, field_name.
search object Búsqueda de subcadenas sin distinguir entre mayúsculas y minúsculas en el contenido de los campos: username, ip, resourcename, details.
countOutput boolean Los siguientes parámetros son comunes en todos los métodos get que son descritos en el comentario de referencia.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores devueltos

(integer/array) Devuelve cualquiera de los dos:

  • Una matriz (array) de objetos;
  • El número de objetos devueltos, si se ha usado el parámetro countOutput.

Ejemplos

Obtener log de auditoría

Obtener los dos últimos registros del log de auditoría.

Petición:

{
           "jsonrpc": "2.0",
           "method": "auditlog.get",
           "params": {
               "output": "extend",
               "sortfield": "clock",
               "sortorder": "DESC",
               "limit": 2
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "auditid": "cksstgfam0001yhdcc41y20q2",
                   "userid": "1",
                   "username": "Admin",
                   "clock": "1629975715",
                   "ip": "127.0.0.1",
                   "action": "1",
                   "resourcetype": "0",
                   "resourceid": "0",
                   "resourcename": "Jim",
                   "recordsetid": "cksstgfal0000yhdcso67ondl",
                   "details": "{\"user.name\":[\"update\",\"Jim\",\"\"],\"user.medias[37]\":[\"add\"],\"user.medias[37].\":[\"add\"],\"user.medias[37].mediatypeid\":[\"add\",\"1\"],\"user.medias[37].sendto\":[\"add\",\"[email protected]\"]}"
                   
               },
               {
                   "auditid": "ckssofl0p0001yhdcqxclsg8r",
                   "userid": "1",
                   "username": "Admin",
                   "clock": "1629967278",
                   "ip": "127.0.0.1",
                   "action": "0",
                   "resourcetype": "0",
                   "resourceid": "20",
                   "resourcename": "John",
                   "recordsetid": "ckssofl0p0000yhdcpxyo1jgo",
                   "details": "{\"user.username\":[\"add\",\"John\"], \"user.userid:\":[\"add\",\"20\"],\"user.usrgrps[28]\":[\"add\"],\"user.usrgrps[28].usrgrpid\":[\"add\", \"7\"]}"
               }
           ],
           "id": 1
       }

Ver también

Fuente

CAuditLog::get() en ui/include/classes/api/services/CAuditLog.php.