auditlog.get

Opis

integer/array auditlog.get(object parameters)

Metoda pozwala na pobieranie logów audytu zgodnie z podanymi parametrami.

Ta metoda jest dostępna tylko dla użytkownika typu Super admin. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry definiujące żądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
auditids string/array Zwróć tylko log audytu z podanymi identyfikatorami ID.
userids string/array Zwróć tylko log audytu, który został utworzony przez podanych użytkowników.
time_from timestamp Zwróć tylko log audytu, który został utworzony przed lub w określonym czasie.
time_till timestamp Zwróć tylko log audytu, który został utworzony po lub w określonym czasie.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości to: auditid, userid, clock.
filter object Zwróć tylko wyniki które dokładnie pasują do podanego filtra.

Akceptuje tablicę, w której klucze są nazwami właściwości, a wartości są albo pojedynczą wartością, albo tablicą wartości do dopasowania.
search object Wyszukaj mniejsze ciągi znaków bez uwzględniania wielkości lister w zawartościach pól: username, ip, resourcename, details.
countOutput boolean Te parametry wspólne dla wszystkich metod get zostały opisane w komentarzu referencyjnym.
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • tliczbę pobranych obiektów, jeśli parametr countOutput został użyty.

Przykłady

Pobierz log audytu

Pobiera dwa najnowsze rekordy z logu audytu.

Zapytanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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