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

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

Примечание

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

Request

GET

https://api360.yandex.net/security/v1/org/{orgId}/audit_log/mail

Path parameters

Name

Description

orgId

Type: integer

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

Query parameters

Name

Description

pageSize

Type: integer

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

afterDate

Type: string<date-time>

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

Example: ``

beforeDate

Type: string<date-time>

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

Example: ``

excludeUids

Type: string<uint64>[]

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

Чтобы указать несколько человек, задайте их идентификаторы отдельными параметрами, например excludeUids={uid1}&excludeUids={uid2}.

Example: ``

includeUids

Type: string<uint64>[]

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

Чтобы указать несколько человек, задайте их идентификаторы отдельными параметрами, например includeUids={uid1}&includeUids={uid2}.

Example: ``

pageToken

Type: string

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

Example: ``

types

Type: string[]

Типы событий, которые должны быть включены в список.

Возможные значение приведены в MailEventMailEventType. Чтобы указать несколько типов, задайте их отдельными параметрами, например types={type1}&types={type2}. Если параметр не указан, то включаются все события.

Example: ``

Responses

200 OK

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

Body

application/json
{
  "events": [
    {
      "eventType": "mailbox_send",
      "date": "2025-01-01T00:00:00Z",
      "orgId": 0,
      "userUid": "example",
      "userLogin": "example",
      "userName": "example",
      "requestId": "example",
      "uniqId": "example",
      "source": "example",
      "actorUid": "example",
      "clientIp": "example",
      "mid": "example",
      "destMid": "example",
      "folderName": "example",
      "folderType": "example",
      "labels": [
        "example"
      ],
      "msgId": "example",
      "subject": "example",
      "from": "example",
      "to": "example",
      "cc": "example",
      "bcc": "example"
    }
  ],
  "nextPageToken": "example"
}

Name

Description

events

Type: v1MailEvent[]

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

Example
[
  {
    "eventType": "mailbox_send",
    "date": "2025-01-01T00:00:00Z",
    "orgId": 0,
    "userUid": "example",
    "userLogin": "example",
    "userName": "example",
    "requestId": "example",
    "uniqId": "example",
    "source": "example",
    "actorUid": "example",
    "clientIp": "example",
    "mid": "example",
    "destMid": "example",
    "folderName": "example",
    "folderType": "example",
    "labels": [
      "example"
    ],
    "msgId": "example",
    "subject": "example",
    "from": "example",
    "to": "example",
    "cc": "example",
    "bcc": "example"
  }
]

nextPageToken

Type: string

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

Example: example

MailEventMailEventType

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

  • mailbox_send — отправка письма;
  • message_receive — прием письма;
  • message_seen — отметка письма прочитанным;
  • message_unseen — отметка письма непрочитанным;
  • message_forward — пересылка письма;
  • message_purge — удаление письма;
  • message_trash — перемещение письма в папку «Удаленные»;
  • message_spam — перемещение письма в папку «Спам»;
  • message_unspam — перемещение письма из папки «Спам»;
  • message_move — перемещение письма между папками;
  • message_copy — копирование письма;
  • message_answer — ответ на письмо.

Type: string

Default: mailbox_send

Enum: mailbox_send, message_receive, message_seen, message_unseen, message_forward, message_purge, message_trash, message_spam, message_unspam, message_move, message_copy, message_answer

v1MailEvent

Name

Description

clientIp

Type: string

IP клиента.

Example: example

date

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

eventType

Type: MailEventMailEventType

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

  • mailbox_send — отправка письма;
  • message_receive — прием письма;
  • message_seen — отметка письма прочитанным;
  • message_unseen — отметка письма непрочитанным;
  • message_forward — пересылка письма;
  • message_purge — удаление письма;
  • message_trash — перемещение письма в папку «Удаленные»;
  • message_spam — перемещение письма в папку «Спам»;
  • message_unspam — перемещение письма из папки «Спам»;
  • message_move — перемещение письма между папками;
  • message_copy — копирование письма;
  • message_answer — ответ на письмо.

Default: mailbox_send

Enum: mailbox_send, message_receive, message_seen, message_unseen, message_forward, message_purge, message_trash, message_spam, message_unspam, message_move, message_copy, message_answer

orgId

Type: integer

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

requestId

Type: string

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

Example: example

source

Type: string

Источник события.

Возможные значения:

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

Example: example

uniqId

Type: string

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

Example: example

userLogin

Type: string

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

Example: example

userName

Type: string

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

Example: example

userUid

Type: string<uint64>

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

Example: example

actorUid

Type: string<uint64>

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

Example: example

bcc

Type: string

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

Example: example

cc

Type: string

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

Example: example

destMid

Type: string

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

Example: example

folderName

Type: string

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

Example: example

folderType

Type: string

Тип папки.

Возможные значения:

  • inbox — «Входящие»;
  • sent — «Отправленные»;
  • trash — «Корзина»;
  • spam — «Спам»;
  • drafts — «Черновики»;
  • outbox — «Исходящие»;
  • archive — «Архив»;
  • template_ — «Шаблоны»;
  • discount — «Скрытые рассылки»;
  • restored — «Восстановленные»;
  • reply_later — «Напомнить позже»;
  • user — папка не является системной (стандартной), а создана пользователем.

Example: example

from

Type: string

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

Example: example

labels

Type: string[]

Системные метки письма.

Массив из возможных значений:

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

mid

Type: string

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

Example: example

msgId

Type: string

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

Example: example

subject

Type: string

Тема письма.

Example: example

to

Type: string

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

Example: example
Example
{
  "eventType": "mailbox_send",
  "date": "2025-01-01T00:00:00Z",
  "orgId": 0,
  "userUid": "example",
  "userLogin": "example",
  "userName": "example",
  "requestId": "example",
  "uniqId": "example",
  "source": "example",
  "actorUid": "example",
  "clientIp": "example",
  "mid": "example",
  "destMid": "example",
  "folderName": "example",
  "folderType": "example",
  "labels": [
    "example"
  ],
  "msgId": "example",
  "subject": "example",
  "from": "example",
  "to": "example",
  "cc": "example",
  "bcc": "example"
}

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

Описание ошибки.

Example: example

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null
Example
{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

Описание ошибки.

Example: example

403 Forbidden

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

Body

application/json
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

Описание ошибки.

Example: example

404 Not Found

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

Body

application/json
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

Описание ошибки.

Example: example

500 Internal Server Error

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

Body

application/json
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

Описание ошибки.

Example: example

No longer supported, please use an alternative and newer version.

Предыдущая
Получить аудит-лог Диска
Следующая
Обзор