Documentation
Table of Contents
auditlog.get
Descripción
integer/array auditlog.get(object parameters)
El método permite recuperar registros de auditoría de acuerdo con los parámetros suministrados.
Este método solo está disponible para el tipo de usuario Super administrador. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Para más información, ver Roles de usuario.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| auditids | cadena/matriz | Devuelve solo el registro de auditoría con los ID proporcionados. |
| userids | cadena/matriz | Devuelve solo el registro de auditoría creado por los usuarios indicados. |
| time_from | timestamp | Devuelve sólo las entradas del registro de auditoría que se han creado después o en el momento indicado. |
| time_till | timestamp | Devuelve sólo las entradas del registro de auditoría que se han creado antes o en el momento dado. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: auditid, userid, clock. |
| filter | objeto | Devuelve sólo resultados que coincidan exactamente con el filtro dado. Acepta una matriz, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores con los que comparar. |
| search | objeto | Búsqueda de subcadenas que no distingue entre mayúsculas y minúsculas en el contenido de los campos: username, ip, resourcename, detailsexcludeSearch. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen en el comentario de referencia. |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorderstartSearch | cadena/matriz | |
| sortorder | booleano |
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
Recuperar registro de auditoría
Recupere los dos registros de auditoría más recientes.
{
"jsonrpc": "2.0",
"method": "auditlog.get",
"params": {
"output": "extend",
"sortfield": "clock",
"sortorder": "DESC",
"limit": 2
},
"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.