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

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

Возвращает список событий в аудит-логе Почты организации.

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

HTTP-запрос

GET https://api360.yandex.net/security/v1/org/{orgId}/audit_log/mail\
?pageSize={integer}\
&pageToken={string}\
&beforeDate={string}\
&afterDate={string}\
&includeUids={array}\
&excludeUids={array}\
&types={array}

Path-параметры

orgId *

integer

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

orgId *

integer

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

Query-параметры

pageSize *

integer

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

pageToken

string

Токен постраничной навигации.

beforeDate

string

Верхняя граница периода выборки в формате ISO 8601, например 2022-12-31T23:59:59+03:00 или 2022-12-31T12:00:00Z. Значение по умолчанию — текущее время.

afterDate

string

Нижняя граница периода выборки в формате ISO 8601, например 2022-12-31T23:59:59+03:00 или 2022-12-31T12:00:00Z.

includeUids

array

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

excludeUids

array

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

types

array

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

pageSize *

integer

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

pageToken

string

Токен постраничной навигации.

beforeDate

string

Верхняя граница периода выборки в формате ISO 8601, например 2022-12-31T23:59:59+03:00 или 2022-12-31T12:00:00Z. Значение по умолчанию — текущее время.

afterDate

string

Нижняя граница периода выборки в формате ISO 8601, например 2022-12-31T23:59:59+03:00 или 2022-12-31T12:00:00Z.

includeUids

array

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

excludeUids

array

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

types

array

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

Ответы

Код 200

Запрос успешно выполнен.

{
  "events": [
    {
      "actorUid": string,
      "bcc": string,
      "cc": string,
      "clientIp": string,
      "date": string,
      "destMid": string,
      "eventType": string,
      "folderName": string,
      "folderType": string,
      "from": string,
      "labels": [
        string
      ],
      "mid": string,
      "msgId": string,
      "orgId": integer,
      "requestId": string,
      "source": string,
      "subject": string,
      "to": string,
      "uniqId": string,
      "userLogin": string,
      "userName": string,
      "userUid": string
    }
  ],
  "nextPageToken": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

events[]

array

Список событий.

events[].actorUid

string

Исполнитель операции от имени ящика.

events[].bcc

string

Адресат из поля «Скрытая копия».

events[].cc

string

Адресат из поля «Копия».

events[].clientIp *

string

IP клиента.

events[].date *

string

Дата и время события по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ssZ.

events[].destMid

string

Идентификатор нового письма при копировании.

events[].eventType *

string

Значение по умолчанию: mailbox_send.

Возможные значения
  1. mailbox_send
  2. message_receive
  3. message_seen
  4. message_unseen
  5. message_forward
  6. message_purge
  7. message_trash
  8. message_spam
  9. message_unspam
  10. message_move
  11. message_copy
  12. message_answer

events[].folderName

string

Название личной (созданной пользователем) папки.

events[].folderType

string

events[].from

string

Отправитель (значение поля «От кого»).

events[].labels[]

array

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

  • seen — письмо просмотренно;
  • attached — письмо с вложением;
  • undo — письмо отправлено с возможностью отмены отправки;
  • delayed — пиьсо отправлено с использованием отложенной отправки.

events[].mid

string

Идентификатор письма.

events[].msgId

string

Заголовок Message-ID письма.

events[].orgId *

integer

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

events[].requestId *

string

Идентификатор запроса в системе. Может быть неуникальным, например при групповых операциях.

events[].source *

string

Источник события.
Возможные значения:

  • server — событие без определённого типа клиента;
  • imap — событие от imap;
  • pop3 — событие от pop3;
  • native — событие от нативных клиентов (web/mobile).

events[].subject

string

Тема письма.

events[].to

string

Получатели (значение поля «Кому»).

events[].uniqId *

string

Уникальный идентификатор события.

events[].userLogin *

string

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

events[].userName *

string

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

events[].userUid *

string

Идентификатор пользователя.

nextPageToken

string

Токен для получения следующей страницы постраничной навигации.

events[]

array

Список событий.

events[].actorUid

string

Исполнитель операции от имени ящика.

events[].bcc

string

Адресат из поля «Скрытая копия».

events[].cc

string

Адресат из поля «Копия».

events[].clientIp *

string

IP клиента.

events[].date *

string

Дата и время события по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ssZ.

events[].destMid

string

Идентификатор нового письма при копировании.

events[].eventType *

string

Значение по умолчанию: mailbox_send.

Возможные значения
  1. mailbox_send
  2. message_receive
  3. message_seen
  4. message_unseen
  5. message_forward
  6. message_purge
  7. message_trash
  8. message_spam
  9. message_unspam
  10. message_move
  11. message_copy
  12. message_answer

events[].folderName

string

Название личной (созданной пользователем) папки.

events[].folderType

string

events[].from

string

Отправитель (значение поля «От кого»).

events[].labels[]

array

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

  • seen — письмо просмотренно;
  • attached — письмо с вложением;
  • undo — письмо отправлено с возможностью отмены отправки;
  • delayed — пиьсо отправлено с использованием отложенной отправки.

events[].mid

string

Идентификатор письма.

events[].msgId

string

Заголовок Message-ID письма.

events[].orgId *

integer

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

events[].requestId *

string

Идентификатор запроса в системе. Может быть неуникальным, например при групповых операциях.

events[].source *

string

Источник события.
Возможные значения:

  • server — событие без определённого типа клиента;
  • imap — событие от imap;
  • pop3 — событие от pop3;
  • native — событие от нативных клиентов (web/mobile).

events[].subject

string

Тема письма.

events[].to

string

Получатели (значение поля «Кому»).

events[].uniqId *

string

Уникальный идентификатор события.

events[].userLogin *

string

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

events[].userName *

string

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

events[].userUid *

string

Идентификатор пользователя.

nextPageToken

string

Токен для получения следующей страницы постраничной навигации.

Код 401

Пользователь не авторизован.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

Запрашиваемый ресурс не найден.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string