Получить аудит-логи

Возвращает список событий в аудит-логе организации. Для этого у организации должен быть подключен тариф с поддержкой аудит-логов. Какие есть тарифы

Поддерживает фильтрацию по времени, типам событий, пользователям, источнику запроса и IP-адресу пользователя – инициатора события. Использует постраничную навигацию для обработки больших наборов данных.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на чтение событий аудит-лога организации ya360_security:read_auditlog. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Запрос

GET https://cloud-api.yandex.net/v1/auditlog/organizations/{org_id}/events

Path-параметры

Имя параметра

Тип

Описание

org_id *

integer

Идентификатор организации.

Query-параметры

Имя параметра

Тип

Описание

started_at

datetime

Дата и время начала аудит-лога в формате ISO 8601, например 2024-01-01T00:00:00+00:00.

ended_at *

datetime

Дата и время окончания аудит-лога в формате ISO 8601, например 2024-01-31T23:59:59+00:00.

types

string

Типы событий, которые должны быть включены в список. Можно указать несколько типов через запятую без пробела, например ya360_b2bplatform_user_created,ya360_b2bplatform_user_dismissed.

count *

integer

Максимальное количество событий на одной странице результатов от 1 до 100.

iteration_key

string

Ключ для получения следующей страницы результатов.

include_uids

string

Список пользователей, действия которых должны быть включены в список событий. Можно указать нескольких пользователей через запятую без пробела, например include_uids=1,2,3. Не используйте вместе с параметром exclude_uids (ниже).

exclude_uids

string

Список пользователей, действия которых должны быть исключены из списка событий. Можно указать нескольких пользователей через запятую без пробела, например exclude_uids=4,5,6. Не используйте вместе с параметром include_uids (выше).

ip

string

IP-адрес, с которого было выполнено действие. Может принимать только одно значение.

service

string

Источник запроса – может принимать только одно значение:

  • Web – веб-сайт;
  • Desktop – программа на компьютере;
  • Mobile – мобильное приложение;
  • Api – внешний HTTP API;
  • Synchronization – внешнее приложение для автоматической синхронизации данных (например, по стандарту SCIM);
  • ID – внутренний сервис авторизации пользователей;
  • Internal – другие внутренние сервисы;
  • Unknown – источник не указан.

Заголовки

Authorization: OAuth <токен>
Пример запроса

curl 'https://cloud-api.yandex.net/v1/auditlog/organizations/8203070/events?ended_at=2025-04-20T16:00:00&count=5' -H "Authorization: OAuth <токен>" | jq .

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком событий.

200 OK — запрос выполнен успешно.

Имя параметра

Тип

Описание

iteration_key

string

Ключ для получения следующей страницы результатов. Отсутствует, если событий больше нет.

items *

auditlogEventArray

Массив событий в аудит-логе.

auditlogEventArray

Массив событий в аудит-логе.

Имя параметра

Тип

Описание

items *

enrichedEvent[]

Событие с указанием логина и имени пользователя – инициатора события.

enrichedEvent

Событие с указанием логина и имени пользователя – инициатора события.

Имя параметра

Тип

Описание

user_login *

string

Логин пользователя.

user_name *

string

Имя пользователя.

event *

auditlogEvent

Событие с указанием всех параметров.

auditlogEvent

Событие с указанием всех параметров.

Имя параметра

Тип

Описание

status *

string

Результат запроса – Success (успешно) или Error (ошибка – например, в событиях авторизации, где был неправильно введен логин или пароль).

idempotency_id *

string

Идентификатор события.

uid

integer

Идентификатор пользователя – инициатора события.

service *

string

Источник запроса. Какие есть источники

ip *

string

IP-адрес пользователя – инициатора события. Для автоматических событий, инициированных не пользователем, указывается адрес локального хоста.

occurred_at *

integer

Дата и время события в формате ISO 8601, например 2025-04-28T13:50:17+00:00.

org_id *

integer

Идентификатор организации.

is_system *

boolean

Параметр не используется, возвращается всегда false.

meta *

object

JSON-фрагмент с дополнительными параметрами.

request_id *

string

Идентификатор запроса – для его отслеживания и быстрой диагностики проблем.

type *

string

Тип события. Какие есть типы
Пример ответа

{
  "iteration_key": "5",
  "items": [
    {
      "user_login": "ppetrov@org-domain.ru",
      "user_name": "Петров Пётр",
      "event": {
        "status": "Success",
        "idempotency_id": "e73d6849-cb9b-4a35-840a-457c2a6d4963",
        "uid": 1130000068926982,
        "service": "ID",
        "ip": "2a02:6bf:8005:f00:61ce:682c:bca4:35e5/128",
        "occurred_at": "2025-04-17T12:38:50+00:00",
        "org_id": 8203070,
        "is_system": false,
        "meta": {
          "device_id": null,
          "revision": "1"
        },
        "request_id": "@899754,1744893529.9158447,2475995728163911,9422b5d6468fe76354d2d2e05551adc8a5,1130000068926982,ppetrov@org-domain.ru",
        "type": "id_cookie.set"
      }
    },
    {
      "user_login": "ppetrov@org-domain.ru",
      "user_name": "Петров Пётр",
      "event": {
        "status": "Success",
        "idempotency_id": "ba93e9fc-f76d-46ee-907d-a4a811658f37",
        "uid": 1130000068926982,
        "service": "ID",
        "ip": "2a02:6b8:b081:b42d::1:1b/128",
        "occurred_at": "2025-04-07T06:02:16+00:00",
        "org_id": 8203070,
        "is_system": false,
        "meta": {
          "device_id": "",
          "revision": "1"
        },
        "request_id": "@8525,1744005736.5869532,8200551962518533,77469233cd7554156f5e33a65d741496a2,1130000068926982,ppetrov@org-domain.ru",
        "type": "id_cookie.set"
      }
    },
    {
      "user_login": "ppetrov@org-domain.ru",
      "user_name": "Петров Пётр",
      "event": {
        "status": "Success",
        "idempotency_id": "dd5891cb-8fb5-426b-add9-542014791a2a",
        "uid": 1130000068926982,
        "service": "ID",
        "ip": "2a02:6bf:8005:f00:2d9b:a9e0:e87b:59ec/128",
        "occurred_at": "2025-04-03T07:25:32+00:00",
        "org_id": 8203070,
        "is_system": false,
        "meta": {
          "device_id": "",
          "revision": "1"
        },
        "request_id": "@347977,1743665132.744608,1285529982496963,3b1018d1a74254b10f3639e4bf6b84aaa3,1130000068926982,ppetrov@org-domain.ru",
        "type": "id_cookie.set"
      }
    },
    {
      "user_login": "ppetrov@org-domain.ru",
      "user_name": "Петров Пётр",
      "event": {
        "status": "Success",
        "idempotency_id": "0e3e886e-38b4-4e51-ab7b-ae4f07042a78",
        "uid": 1130000068926982,
        "service": "ID",
        "ip": "2a02:6b8:b081:b41b::1:12/128",
        "occurred_at": "2025-03-28T10:52:47+00:00",
        "org_id": 8203070,
        "is_system": false,
        "meta": {
          "device_id": "",
          "revision": "1"
        },
        "request_id": "@44559,1743159167.6186025,6525975479418730,3ffa189299c76d9c6dda856176f72e66a2,1130000068926982,ppetrov@org-domain.ru",
        "type": "id_cookie.set"
      }
    },
    {
      "user_login": "ppetrov@org-domain.ru",
      "user_name": "Петров Пётр",
      "event": {
        "status": "Success",
        "idempotency_id": "cff0ef6c-7915-4a38-a413-01dd4c19fc99",
        "uid": 1130000068926982,
        "service": "ID",
        "ip": "2a02:6bf:8005:f00:e57b:5da2:7b42:e68b/128",
        "occurred_at": "2025-03-27T08:19:39+00:00",
        "org_id": 8203070,
        "is_system": false,
        "meta": {
          "device_id": "",
          "revision": "1"
        },
        "request_id": "@72181,1743063579.3576896,8037914737293583,bb6b033f04f7997ff5d941b7e89cd6e6ab,1130000068926982,ppetrov@org-domain.ru",
        "type": "id_cookie.set"
      }
    }
  ]
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

  • 400 Bad Request – параметры запроса не заданы или заданы неверно;
  • 401 Unauthorized – пользователь не авторизован;
  • 403 Forbidden – у пользователя или приложения нет прав на доступ к аудит-логу организации;
  • 404 Not Found – запрашиваемый аудит-лог организации не найден;
  • 500 Internal Server Error – ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

Типы событий в ответе

Важно

Этот метод не возвращает списки событий Почты и Диска. Как их получить

События авторизации пользователей-сотрудников

Имя события

Описание

id_cookie.set

Вход через браузер.

id_nondevice_token.issued

Вход с помощью OAuth-токена.

id_device_token.issued

Вход через мобильное приложение.

id_app_password.login

Вход с использованием пароля приложения.

id_account.glogout

Выход из аккаунта на всех устройствах.

id_account.changed_password

Смена пароля пользователя.

События управления аккаунтами пользователей-сотрудников

Имя события

Описание

user_created

Создание пользователя.

user_dismissed

Удаление пользователя.

user_blocked

Блокировка пользователя.

user_unblocked

Разблокировка пользователя.

user_updated

Изменение данных пользователя.

user_alias_created

Добавление почтового алиаса – дополнительного адреса электронной почты, письма с которого перенаправляются на основной почтовый ящик пользователя.

user_alias_deleted

Удаление почтового алиаса.

user_password_updated

Смена пароля пользователя администратором.

invite_created

Создание ссылки приглашения в организацию.

invite_updated

Переход по ссылке приглашения в организацию.

События управления организацией

Имя события

Описание

organization_owner_updated

Смена владельца организации.

organization_updated

Изменение данных организации.

organization_sso_settings_updated

Изменение настроек единого входа (SSO).

domain_created

Добавление домена.

domain_deleted

Удаление домена.

domain_updated

Изменение домена.

События управления группами и подразделениями

Имя события

Описание

group_created

Создание группы.

group_deleted

Удаление группы.

group_updated

Изменение параметров группы.

group_member_created

Добавление в группу.

group_member_deleted

Удаление из группы.

department_created

Создание подразделения.

department_deleted

Удаление подразделения.

department_updated

Изменение данных подразделения.

department_member_created

Добавление в подразделение.

department_member_deleted

Удаление из подразделения.

События Телемоста

Имя события

Описание

telemost_conference.created

Создание конференции с уровнем доступа ADMINS (с комнатой ожидания для всех, кроме организаторов), ORGANIZATION (с комнатой ожидания для всех, кроме сотрудников организации) или PUBLIC (без комнаты ожидания).

telemost_conference.access_level_changed

Изменение уровня доступа конференции.

telemost_conference.started

Начало конференции.

telemost_conference.ended

Завершение конференции.

telemost_conference.peer.joined

Подключение участника к конференции в роли MEMBER (простой участник), ADMIN (модератор) или OWNER (владелец).

telemost_conference.peer.kicked

Удаление участника конференции модератором.

telemost_conference.peer.role_changed

Изменение роли участника конференции модератором.

telemost_conference.waiting_room.peer.joined

Подключение участника к комнате ожидания.

telemost_conference.waiting_room.peer.admitted

Переход участника из комнаты ожидания в конференцию.

telemost_conference.waiting_room.peer.left

Выход участника из комнаты ожидания.

telemost_conference.live_stream.created

Создание трансляции с уровнем доступа ORGANIZATION (с комнатой ожидания для всех, кроме сотрудников организации) или PUBLIC (без комнаты ожидания).

telemost_conference.live_stream.started

Начало трансляции.

telemost_conference.live_stream.access_level_changed

Изменение уровня доступа трансляции.

telemost_conference.live_stream.ended

Завершение трансляции.

telemost_conference.live_stream.viewer.joined

Подключение участника к трансляции.

События Мессенджера

Имя события

Описание

messenger_chat.created

Создание чата типа private (закрытый), group (открытый) или channel (канал).

messenger_chat.info_changed

Изменение настроек чата.

messenger_chat.invite_link_renewed

Обновление ссылки на чат.

messenger_chat.member_rights_changed

Изменение прав участников чата.

messenger_chat.member.added

Добавление пользователя в роли member (участник), admin (модератор) или subscriber (подписчик) в чат.

messenger_chat.member.role_changed

Изменение роли участника.

messenger_chat.member.removed

Удаление пользователя из чата.

messenger_chat.group_added

Добавление группы в чат.

messenger_chat.group_removed

Удаление группы из чата.

messenger_chat.department_added

Добавление подразделения в чат.

messenger_chat.department_removed

Удаление подразделения из чата.

messenger_chat.file_sent

Отправка файла в чат.

messenger_chat.message_deleted

Удаление сообщения из чата.

messenger_chat.call_started

Начало звонка в чате.

messenger_user.takeout_requested

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

События ресурсов организации

Имя события

Описание

resource_shared_mailbox_created

Создание общего почтового ящика.

resource_shared_mailbox_deleted

Удаление общего почтового ящика.

resource_shared_mailbox_updated

Изменение данных общего почтового ящика.

resource_delegated_mailbox_created

Делегирование почтового ящика – предоставление доступа к почтовому ящику для работы от имени его владельца.

resource_delegated_mailbox_deleted

Отмена делегирования почтового ящика.

resource_shared_disk_created

Создание общего диска.

resource_shared_disk_deleted

Удаление общего диска.

resource_office_created

Создание офиса.

resource_office_deleted

Удаление офиса.

resource_office_updated

Изменение данных офиса.

resource_room_created

Создание переговорки.

resource_room_deleted

Удаление переговорки.

resource_room_updated

Изменение данных переговорки.

resource_shared_contact_created

Создание внешнего контакта.

resource_shared_contact_deleted

Удаление внешнего контакта.

resource_shared_contact_updated

Изменение данных внешнего контакта.
Предыдущая
Обзор
Следующая
Обзор