auditlog.get

Описание

integer/array auditlog.get(параметры объекта)

Метод позволяет получить записи журнала аудита в соответствии с заданными параметрами.

Этот метод доступен только пользователю с типом доступа Супер-администратор. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(объект) Параметры, определяющие желаемый результат.

Метод поддерживает следующие параметры.

Параметр	Тип	Описание
auditids	string/array	Возвращает только журнал аудита с указанными идентификаторами.
userids	string/array	Возвращает только журнал аудита созданный указанными пользователями.
time_from	timestamp	Возвращает только те записи журнала аудита, которые были созданы после или в указанное время.
time_till	timestamp	Возвращает только те записи журнала аудита, которые были созданы до или в указанное время.
sortfield	string/array	Сортировать результат по заданным свойствам. Возможные значения: `auditid`, `userid`, `clock`.
filter	object	Возвращает только те результаты, которые точно соответствуют заданному фильтру. Принимает массив где ключами являются имена свойств, а значениями являются либо одно значение, либо массив значений для сопоставления. Дополнительно поддерживает фильтрацию по полям свойств деталей: `table_name`, `field_name`.
search	object	Нечувствительный к регистру поиск подстроки в содержимом полей: `username`, `ip`, `resourcename`, `details`.
countOutput	boolean	Эти параметры являются общими для всех методов `get` и описаны в справочном комментарии.
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Возвращаемые значения

(integer/array) Возвращает:

· массив объектов;
· количество извлеченных объектов, если использовался параметр countOutput.

Примеры

Получить audit log

Получить две последние записи журнала аудита.

Запрос:

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

Ответ:

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

Смотрите также

· Audit log object

Источник

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

Documentation