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

  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/disk\
?pageSize={integer}\
&pageToken={string}\
&beforeDate={string}\
&afterDate={string}\
&includeUids={array}\
&excludeUids={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

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

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

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

Ответы

Код 200

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

{
  "events": [
    {
      "clientIp": string,
      "date": string,
      "eventType": string,
      "lastModificationDate": string,
      "orgId": integer,
      "ownerLogin": string,
      "ownerName": string,
      "ownerUid": string,
      "path": string,
      "requestId": string,
      "resourceFileId": string,
      "rights": string,
      "size": string,
      "uniqId": string,
      "userLogin": string,
      "userName": string,
      "userUid": string
    }
  ],
  "nextPageToken": string
}
Скопировано

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

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

Поля

events[]

array

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

events[].clientIp

string

IP клиента.

events[].date *

string

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

events[].eventType *

string

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

  • fs-copy — копирование на свой Диск;
  • fs-mkdir — создание папки;
  • fs-move — перемещение;
  • fs-set-public — публикация файла по ссылке;
  • fs-store — загрузка файла;
  • fs-trash-append — перенос в Корзину;
  • fs-trash-drop — удаление из Корзины;
  • fs-trash-drop-all — очистка Корзины;
  • share-activate-invite — принятие приглашения;
  • share-change-rights — изменение уровня общего доступа;
  • share-change-invite-rights — изменение уровня доступа для приглашения;
  • share-create-group — общий доступ к папке;
  • share-invite-user — приглашение в группу;
  • fs-rm — удаление без переноса в Корзину (с использованием протокола WebDAV).

events[].lastModificationDate

string

Дата и время последней модификации файла или папки по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ssZ. Отсутствие даты у некоторых событий обозначается «нулевым» временем: 1970-01-01T00:00:00Z.

events[].orgId *

integer

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

events[].ownerLogin

string

Логин владельца файла или папки. Может быть пустым, например при очистке Корзины.

events[].ownerName

string

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

events[].ownerUid

string

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

events[].path

string

Путь расположения файла или папки.

events[].requestId *

string

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

events[].resourceFileId

string

Идентификатор файла или папки. Может быть пустым, например при очистке Корзины.

events[].rights

string

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

events[].size

string

Размер файла в байтах. Может быть равен нулю, например при создании папки или очистке Корзины.

events[].uniqId *

string

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

events[].userLogin *

string

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

events[].userName *

string

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

events[].userUid *

string

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

nextPageToken

string

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

events[]

array

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

events[].clientIp

string

IP клиента.

events[].date *

string

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

events[].eventType *

string

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

  • fs-copy — копирование на свой Диск;
  • fs-mkdir — создание папки;
  • fs-move — перемещение;
  • fs-set-public — публикация файла по ссылке;
  • fs-store — загрузка файла;
  • fs-trash-append — перенос в Корзину;
  • fs-trash-drop — удаление из Корзины;
  • fs-trash-drop-all — очистка Корзины;
  • share-activate-invite — принятие приглашения;
  • share-change-rights — изменение уровня общего доступа;
  • share-change-invite-rights — изменение уровня доступа для приглашения;
  • share-create-group — общий доступ к папке;
  • share-invite-user — приглашение в группу;
  • fs-rm — удаление без переноса в Корзину (с использованием протокола WebDAV).

events[].lastModificationDate

string

Дата и время последней модификации файла или папки по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ssZ. Отсутствие даты у некоторых событий обозначается «нулевым» временем: 1970-01-01T00:00:00Z.

events[].orgId *

integer

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

events[].ownerLogin

string

Логин владельца файла или папки. Может быть пустым, например при очистке Корзины.

events[].ownerName

string

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

events[].ownerUid

string

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

events[].path

string

Путь расположения файла или папки.

events[].requestId *

string

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

events[].resourceFileId

string

Идентификатор файла или папки. Может быть пустым, например при очистке Корзины.

events[].rights

string

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

events[].size

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