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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Query parameters

Name

Description

pageSize*

Type: integer<int64>

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

afterDate

Type: string<date-time>

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

beforeDate

Type: string<date-time>

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

excludeUids

Type: string<uint64>[]

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

includeUids

Type: string<uint64>[]

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

pageToken

Type: string

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

Responses

200 OK

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

Body

application/json
{
    "events": [
        {
            "eventType": "string",
            "date": "2022-12-29T18:02:01Z",
            "orgId": 0,
            "userUid": "string",
            "userLogin": "string",
            "userName": "string",
            "ownerUid": "string",
            "ownerLogin": "string",
            "ownerName": "string",
            "resourceFileId": "string",
            "path": "string",
            "size": "string",
            "lastModificationDate": "2022-12-29T18:02:01Z",
            "rights": "string",
            "requestId": "string",
            "uniqId": "string",
            "clientIp": "string"
        }
    ],
    "nextPageToken": "string"
}

Name

Description

events

Type: v1DiskEvent[]

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

nextPageToken

Type: string

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

v1DiskEvent

Name

Description

date*

Type: string<date-time>

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

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

orgId*

Type: integer<int64>

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

requestId*

Type: string

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

uniqId*

Type: string

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

userLogin*

Type: string

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

userName*

Type: string

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

userUid*

Type: string<uint64>

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

clientIp

Type: string

IP клиента.

lastModificationDate

Type: string<date-time>

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

ownerLogin

Type: string

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

ownerName

Type: string

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

ownerUid

Type: string<uint64>

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

path

Type: string

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

resourceFileId

Type: string

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

rights

Type: string

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

size

Type: string<uint64>

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

401 Unauthorized

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

403 Forbidden

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

404 Not Found

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

500 Internal Server Error

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

Предыдущая