auditlog.get

Descripció

integer/array auditlog.get(object parameters)

El mètode permet recuperar els objectes de registre d'auditoria segons els paràmetres proveïts.

Aquest mètode és disponible només per a usuaris de tipus Super admin. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
auditids cadena/matriu Retorna només el registre d'auditoria amb els ID donats.
userids cadena/matriu Retorna només el registre d'auditoria creat pels usuaris donats.
time_from timestamp Retorna només les entrades del registre d'auditoria que s'han creat després o en el moment donat.
time_till timestamp Retorna només les entrades del registre d'auditoria que s'han creat abans o en el moment donat.
sortfield cadena/matriu Ordena el resultat per les propietats donades.

Valors possibles: auditid, userid, clock.
filter objecte Retorna només els resultats que coincideixen exactament amb el filtre donat.

Admet una matriu, on les claus són noms de propietats i els valors són un valor únic o una matriu de valors amb els quals coincideix.
search objecte Cerca de subcadenes que no distingeix entre majúscules i minúscules al contingut dels camps: nom d'usuari, ip, nom del recurs, detalls.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar registre d'auditoria

Recupera els dos darrers registres del registre d'auditoria.

Petició:

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

Resposta:

{
           "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
       }

Veieu també

Font

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