Documentation
Table of Contents
auditlog.get
Description
integer/array auditlog.get(paramètres d'objet)
Cette méthode permet de récupérer les enregistrement du journal d'audit en fonction des paramètres donnés.
Cette méthode est seulement disponible pour les utilisateurs du type Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôle d'utilisateur. Voir Rôles utilisateur pour plus d'informations.
Paramètres
(objet) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants :
| Paramètre | Type | Description |
|---|---|---|
| auditids | string/array | Renvoyer uniquement le journal d'audit avec les ID donnés. |
| userids | string/array | Renvoyer uniquement les journaux d'audit qui ont été créés par les utilisateurs donnés. |
| time_from | timestamp | Renvoie uniquement les entrées du journal d'audit qui ont été créées après ou à l'heure donnée. |
| time_till | timestamp | Renvoie uniquement les entrées du journal d'audit qui ont été créées avant ou à l'heure donnée. |
| sortfield | string/array | Trier le résultat selon les propriétés données. Les valeurs possibles sont : auditid, userid, clock. |
| filter | object | Renvoyer uniquement les résultats qui correspondent exactement au filtre donné. Accepte un tableau, où les clés sont des noms de propriété et les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.< br> Prend également en charge le filtrage par champs de propriété de détails : table_name, field_name. |
| search | object | Recherche de sous-chaîne insensible à la casse dans le contenu des champs : username, ip, resourcename, details. |
| countOutput | boolean | Ces paramètres étant communs à toutes les méthodes get, ils sont décrits dans le commentaire de référence. |
| excludeSearch | boolean | |
| limite | integer | |
| sortie | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| ordredetri | string/array | |
| startSearch | boolean |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupérer le journal d'audit
Récupérer les deux derniers enregistrements du journal d'audit.
Requête :
{
"jsonrpc": "2.0",
"method": "auditlog.get",
"params": {
"output": "extend",
"sortfield": "clock",
"sortorder": "DESC",
"limit": 2
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"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
}Voir également
Source
CAuditLog::get() dans ui/include/classes/api/services/CAuditLog.php.