API ReferenceЖурналыаудита

Получение записей журнала аудита для указанного пользователя

Получайте журналы аудита для указанного пользователя с возможностями фильтрации с помощью параметров запроса. Удобнее всего воспринимать это как журнал activity log для выбранного пользователя

Аутентификация

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

user_idstringОбязательныйformat: "uuid"По умолчанию erfb57e0-79f2-4bc7-9b70-99fbc175175c
User ID

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

filters[start_date]stringОпциональныйformat: "date"

Начальная дата (ISO)

filters[end_date]stringОпциональныйformat: "date"

Конечная дата (ISO)

filters[resource_type]enumОпциональный

Фильтровать по типу ресурса

filters[event_type]enumОпциональный

Фильтровать по типу действий

filters[team_id]stringОпциональныйformat: "uuid"

Фильтровать по ИД команды

filters[project_id]stringОпциональныйformat: "uuid"

Фильтровать по ИД проекта

filters[resource_id]stringОпциональныйformat: "uuid"

Фильтровать по ИД ресурса (ИД ресурса, ИД проекта, ИД пользователя)

filters[user_id]stringОпциональныйformat: "uuid"

Фильтровать по ИД пользователя

filters[ip_address]stringОпциональный

Фильтровать по IP-адресу

pageintegerОпциональныйПо умолчанию 1

Номер страницы

page_sizeintegerОпциональный<=200По умолчанию 50

Записей на странице

Заголовки ответа

page-numberinteger
Current page of results
per-pageinteger
Number of entries per page
totalinteger
Total entries across all pagess
total-pagesinteger
Number of pages

Ответ

Succesful Event logs response
account_idstring or nullОпциональныйformat: "uuid"
anonymous_user_idstring or nullОпциональныйformat: "uuid"
clientstring or nullОпциональный

Клиент API, запустивший событие аудита. Не всегда будет заполняться.

Когда API-вызов, запустивший событие, сделан с помощью приложения Oauth, он выглядит так: “oauth_app/:uuid”, но если он сделан с помощью токена разработчика, он выглядит так: “user_token/:uuid”, где UUID — это ИД пользователя, которому принадлежит данный токен

Примеры:

  • “user_token/57823879-e541-49b0-b902-c43794c4400c”
  • “oauth_app/80ccf0bb-ae91-49c4-8aec-8f6238c14947”
  • “web/2024-06-10-18-15”
  • “pipeline-media-warden/cbd0061f6f190489e8af3137b8707b33f498f53f”
  • “null”
event_typeenumОпциональный
event_detailsobjectОпциональный

Сведения о событии. Они сильно различаются в зависимости от типа события, но несколько примеров см. в примерах ответов.

iddoubleОпциональный

Уникальный идентификатор

inserted_atstringОпциональныйformat: "date-time"
ip_addressstring or nullОпциональный

IP-адрес, связанный с этим событием

project_idstring or nullОпциональныйformat: "uuid"

ИД проекта, в котором произошло это действие

resource_idstringОпциональныйformat: "uuid"

ИД упоминаемого ресурса

resource_typeenumОпциональный

Тип ресурса, на который дана ссылка

team_idstring or nullОпциональныйformat: "uuid"

ИД команды

sourceenumОпциональный

Источник действия, в результате которого создана указанная запись журнала аудита

user_idstring or nullОпциональныйformat: "uuid"

ИД пользователя

updated_atstringОпциональныйformat: "date-time"

Ошибки

401
Unauthorized Error
404
Not Found Error