Для разработчиков

Журнал аудита событий

GET/audit_events
audit_events:readКорпорация

Метод для получения логов событий на основе указанных фильтров.

Параметры строки запроса

start_time
string, (date-time)
Начальная метка времени (включительно)
Пример:2025-05-01T09:11:00.000Z
end_time
string, (date-time)
Конечная метка времени (включительно)
Пример:2025-05-02T09:11:00.000Z
event_key
string
Фильтр по конкретному типу события
Возможные значения
Пример:user_login
actor_id
string
Идентификатор пользователя, выполнившего действие
Пример:98765
actor_type
string
Тип актора
Пример:User
entity_id
string
Идентификатор затронутой сущности
Пример:98765
entity_type
string
Тип сущности
Пример:User
limit
integer, (int32)
Количество записей для возврата
Пример:1
По умолчанию:
50
Диапазон:
<= 50
cursor
string
Курсор для пагинации (из meta.paginate.next_page или meta.paginate.prev_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
string
*
Уникальный идентификатор события
Пример:a1b2c3d4-5e6f-7g8h-9i10-j11k12l13m14
created_at
string, (date-time)
*
Дата и время создания события (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2025-05-15T14:30:00.000Z
event_key
string
*
Ключ типа события
Возможные значения
Пример:user_login
entity_id
string
*
Идентификатор затронутой сущности
Пример:98765
entity_type
string
*
Тип затронутой сущности
Пример:User
actor_id
string
*
Идентификатор пользователя, выполнившего действие
Пример:98765
actor_type
string
*
Тип актора
Пример:User
details
anyOf
*
Дополнительные детали события. Структура зависит от значения event_key — см. описания значений поля event_key. Для событий без деталей возвращается пустой объект.
AuditDetailsEmptyobject
AuditDetailsUserUpdatedobject
AuditDetailsRoleChangedobject
AuditDetailsTagNameobject
AuditDetailsInitiatorobject
AuditDetailsInviterobject
AuditDetailsChatRenamedobject
AuditDetailsChatPermissionobject
AuditDetailsTagChatobject
AuditDetailsChatIdobject
AuditDetailsTokenScopesobject
AuditDetailsKmsobject
AuditDetailsDlpobject
AuditDetailsSearchobject
AuditDetailsBotobject
AuditDetailsBotScopesobject
AuditDetailsBotWebhookSettingsobject
AuditDetailsBotOAuthClientobject
AuditDetailsOAuthAuthorizationGrantedobject
AuditDetailsOAuthAuthorizationRevokedobject
AuditDetailsVideoCallStartedobject
AuditDetailsVideoCallFinishedobject
AuditDetailsVideoCallRecordingobject
ip_address
nullablestring
*
IP-адрес, с которого было выполнено действие. null у событий, записанных без запроса пользователя.
Пример:192.168.1.100
user_agent
nullablestring
*
User agent клиента, обрезается до 255 символов. null у событий, записанных без запроса пользователя.
Пример:Pachca/3.60.0 (co.staply.pachca; build:15; iOS 18.5.0) Alamofire/5.0.0
meta
object
*
Метаданные пагинации
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:eyJxZCO2MiwiZGlyIjoiYXNjIn0
has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице — false.
Пример:true
has_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора — false.
Пример:false
Журнал аудита событий
# Добавьте --all для автоматической пагинацииpachca security list \  --start-time=2025-05-01T09:11:00.000Z \  --end-time=2025-05-02T09:11:00.000Z \  --event-key=user_login \  --actor-id=98765 \  --actor-type=User \  --entity-id=98765 \  --entity-type=User \  --limit=1 \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 200
{  "data": [    {      "id": "a1b2c3d4-5e6f-7g8h-9i10-j11k12l13m14",      "created_at": "2025-05-15T14:30:00.000Z",      "event_key": "user_login",      "entity_id": "98765",      "entity_type": "User",      "actor_id": "98765",      "actor_type": "User",      "details": null,      "ip_address": "192.168.1.100",      "user_agent": "Pachca/3.60.0 (co.staply.pachca; build:15; iOS 18.5.0) Alamofire/5.0.0"    }  ],  "meta": {    "paginate": {      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3",      "prev_page": "eyJxZCO2MiwiZGlyIjoiYXNjIn0",      "has_next": true,      "has_prev": false    }  }}