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

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

Необходимые права доступа для OAuth-приложения:

• cloud_api:disk.read

Формат запроса

Метод: GET.

https://cloud-api.yandex.net/v1/disk/public/resources/admin/accessible-resources
 ? user_id=<идентификатор (UID) сотрудника организации>
 & org_id=<идентификатор организации>
 & [include_group_access=<включать ли ресурсы, доступные группам, подразделениям и организации сотрудника>]
 & [limit=<ограничение на количество возвращаемых ресурсов>]
 & [iteration_key=<ключ итерирования>]

Описание query-параметров

user_id*

Идентификатор (UID) сотрудника организации.

org_id*

Идентификатор организации в Яндекс 360 для бизнеса.

Чтобы посмотреть идентификатор в интерфейсе, откройте кабинет организации и выберите Общие настройки → Профиль организации. Идентификатор будет указан под названием организации.

include_group_access

Параметр, который задает, надо ли включать в ответ список ресурсов, доступных группам, подразделениям и организации, в которых состоит сотрудник.

Допустимые значения:

• false — не включать список ресурсов, доступных группам, подразделениям и организации (используется по умолчанию).
• true — включать список ресурсов, доступных группам, подразделениям и организации.

limit

Количество ресурсов, вложенных в папку, описание которых следует вернуть в ответе (используется для постраничного вывода).

Значение по умолчанию — 100.

iteration_key

Ключ итерирования — параметр, который используется для управления процессом получения данных частями (постранично). Он позволяет API понимать, на каком этапе находится процесс вывода данных, и возвращать следующую порцию информации при последующих запросах.

Ключ итерирования генерируется сервером и передается в ответе вместе с первой порцией данных. Включите этот ключ в следующий запрос, чтобы сервер мог определить, какие данные уже были получены, и вернуть следующую страницу результатов.

* Обязательный параметр.

Заголовок

Authorization: OAuth <token>

Формат ответа

Успешный ответ

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает ссылку на опубликованный ресурс в теле ответа (в объекте ResourceListAccess).

Пример ответа:

{
    "items": [
        {
            "uid": "128280859",
            "path": "/disk/dir_admin",
            "public_hash": "/6qcdDRxMeG94WxbQWNnPnR02YBr9FBxAFS9Q9rUZRkkKKlXjO0fRKBPETdxtNvIq/J6bpmRyOJofT3VoXnDag=="
        },
        {
            "uid": "415265582",
            "path": "/disk/file coworker1.jpeg",
        },
        {
            "uid": "415265999",
            "path": "/disk/file coworker2.jpeg",
            "public_hash": "h1r6TXoIdAv+LnkFlH26GOZLVc0fMRGbQToyhWKnPlq/o9BdjImV/6O4n4Z7CPXzq/J6bpmRyOJofT3VoXnDag=="
        }
    ],
    "iteratation_key": "string",
    "limit": 10
}

Описание элементов ответа

ResourceListAccess

ResourceAccess

Ответ с ошибкой

Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.

Некоторые возможные ошибки:

• 400 — Некорректный запрос.
• 401 — Не авторизован.
• 403 — API недоступно. Ваши файлы занимают больше места, чем у вас есть. Удалите лишнее или увеличьте объём Диска. / Отправитель запроса не является администратором в организации.
• 404 — Не удалось найти запрошенный ресурс. / Пользователь с user_id не состоит в организации, в которой состоит администратор.
• 503 — Сервис временно недоступен.