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

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

Примечание

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

Request

GET

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

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: ``

Responses

200 OK

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

Body

application/json
{
  "events": [
    {
      "eventType": "example",
      "date": "2025-01-01T00:00:00Z",
      "orgId": 0,
      "userUid": "example",
      "userLogin": "example",
      "userName": "example",
      "ownerUid": "example",
      "ownerLogin": "example",
      "ownerName": "example",
      "resourceFileId": "example",
      "path": "example",
      "size": "example",
      "lastModificationDate": "2025-01-01T00:00:00Z",
      "rights": "example",
      "requestId": "example",
      "uniqId": "example",
      "clientIp": "example"
    }
  ],
  "nextPageToken": "example"
}

Name

Description

events

Type: v1DiskEvent[]

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

Example
[
  {
    "eventType": "example",
    "date": "2025-01-01T00:00:00Z",
    "orgId": 0,
    "userUid": "example",
    "userLogin": "example",
    "userName": "example",
    "ownerUid": "example",
    "ownerLogin": "example",
    "ownerName": "example",
    "resourceFileId": "example",
    "path": "example",
    "size": "example",
    "lastModificationDate": "2025-01-01T00:00:00Z",
    "rights": "example",
    "requestId": "example",
    "uniqId": "example",
    "clientIp": "example"
  }
]

nextPageToken

Type: string

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

Example: example

v1DiskEvent

Name

Description

date

Type: string<date-time>

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

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

eventType

Type: 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).

Example: example

orgId

Type: integer

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

requestId

Type: string

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

Example: example

uniqId

Type: string

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

Example: example

userLogin

Type: string

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

Example: example

userName

Type: string

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

Example: example

userUid

Type: string<uint64>

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

Example: example

clientIp

Type: string

IP клиента.

Example: example

lastModificationDate

Type: string<date-time>

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

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

ownerLogin

Type: string

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

Example: example

ownerName

Type: string

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

Example: example

ownerUid

Type: string<uint64>

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

Example: example

path

Type: string

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

Example: example

resourceFileId

Type: string

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

Example: example

rights

Type: string

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

Example: example

size

Type: string<uint64>

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

Example: example
Example
{
  "eventType": "example",
  "date": "2025-01-01T00:00:00Z",
  "orgId": 0,
  "userUid": "example",
  "userLogin": "example",
  "userName": "example",
  "ownerUid": "example",
  "ownerLogin": "example",
  "ownerName": "example",
  "resourceFileId": "example",
  "path": "example",
  "size": "example",
  "lastModificationDate": "2025-01-01T00:00:00Z",
  "rights": "example",
  "requestId": "example",
  "uniqId": "example",
  "clientIp": "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.

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