Получить события аудита
Возвращает список событий аудита организации. Требуется персональный токен доступа со скоупом organization:audit_events_read. Владелец токена должен быть администратором организации.
/v1/organizations/{organizationId}/audit_eventsAuthorizationBearer token (holst_pat_...) · headerrequiredПерсональный токен доступа Holst, передаваемый в заголовке Authorization в формате Bearer holst_pat_....
organizationIdstring<uuid>requiredИдентификатор организации, для которой нужно вернуть события аудита.
actionTypesstring[]Типы действий, которые нужно включить. Передайте несколько значений через запятую. Если параметр не указан, возвращаются события всех типов.
startTimestring<date-time>Самое раннее время события в формате RFC 3339. Граница включается в выборку. Если параметр не указан, нижняя временная граница не применяется.
endTimestring<date-time>Самое позднее время события в формате RFC 3339. Граница включается в выборку и не может быть раньше startTime. Если параметр не указан, верхняя временная граница не применяется. Для стабильной конечной выгрузки в порядке возрастания задайте endTime и не меняйте его при переходе между страницами.
pageSizeintegerМаксимальное количество событий на странице.
orderstringНаправление сортировки событий по occurredAt, затем по id.
ascdesccursorstringКурсор пагинации из поля nextCursor предыдущего ответа. Курсор непрозрачен, обозначает только позицию и не сохраняет параметры запроса. При получении следующей страницы используйте те же фильтры и порядок сортировки. Их изменение может привести к пропуску или повторному получению событий.
Страница событий аудита организации.
auditEventsAuditEvent[]requiredСобытия аудита в запрошенном порядке сортировки.
Show propertiesHide properties
AuditEventidstringrequiredoccurredAtstring<date-time>requiredactionAuditEventActionrequiredShow propertiesHide properties
typestringrequiredРасширяемый идентификатор действия.
detailsobjectrequiredМетаданные действия, набор полей которых зависит от action.type.
actorAuditEventActorrequiredShow propertiesHide properties
typestringrequiredТип инициатора: user, anonymous, system или unknown.
idstringrequirednamestringemailstringcontextAuditEventContextrequiredShow propertiesHide properties
requestIdstringsessionIdstringrequestIpstringscopeAuditEventScoperequiredShow propertiesHide properties
organizationIdstringrequiredworkspaceIdstringworkspaceNamestringchannelIdstringentityAuditEventEntityrequiredShow propertiesHide properties
typestringТип объекта: channel, workspace, organization или user.
subtypestringidstringnamestringemailstringnextCursorstringКурсор для получения следующей страницы. Отсутствует, если больше событий нет.
Некорректный запрос.
errCodestringrequiredМашиночитаемый код ошибки.
msgstringrequiredПонятное человеку сообщение об ошибке.
varsobject | nullrequiredСтруктурированные значения, связанные с ошибкой, или null.
Данные аутентификации отсутствуют или недействительны.
errCodestringrequiredМашиночитаемый код ошибки.
msgstringrequiredПонятное человеку сообщение об ошибке.
varsobject | nullrequiredСтруктурированные значения, связанные с ошибкой, или null.
У аутентифицированного клиента нет прав на выполнение операции.
errCodestringrequiredМашиночитаемый код ошибки.
msgstringrequiredПонятное человеку сообщение об ошибке.
varsobject | nullrequiredСтруктурированные значения, связанные с ошибкой, или null.
Аутентифицированный пользователь превысил ограничение частоты запросов.
errCodestringrequiredМашиночитаемый код ошибки.
msgstringrequiredПонятное человеку сообщение об ошибке.
varsobject | nullrequiredСтруктурированные значения, связанные с ошибкой, или null.
При обработке запроса произошла непредвиденная ошибка.
errCodestringrequiredМашиночитаемый код ошибки.
msgstringrequiredПонятное человеку сообщение об ошибке.
varsobject | nullrequiredСтруктурированные значения, связанные с ошибкой, или null.