Список доступов к общему диску

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

Метод могут использовать как администраторы, так и другие сотрудники организации.

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

  • cloud_api:disk.read

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/virtual-disks/permissions
 ? vd_hash=<метка общего диска>

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

vd_hash*
Метка общего диска. Пример vd_hash: 9Uyws5pZmXgDNA. Метку общего диска можно получить:
  • по API — с помощью метода, который возвращает информацию о статусе создания общего диска;
  • в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после vd/.

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

Authorization: OAuth <token>

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

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

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает объект VirtualDiskPermissions со списком субъектов (сотрудников, групп или подразделений), которые имеют доступ к общему диску. Внутри групп и подразделений доступ к общему диску будет только у тех сотрудников, электронные адреса которых находятся на домене организации.

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

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

{
  "items": [
    {
      "rights": [
        "read",
        "write"
      ],
      "id": 2,
      "type": "department",
      "org_id": 123456
    },
    {
      "rights": [
        "read",
        "write"
      ],
      "id": 1130000006678996,
      "type": "user",
      "org_id": 123456
    },
    {
      "rights": [
        "write"
      ],
      "id": 5,
      "type": "group",
      "org_id": 123456
    }
  ]
}

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

VirtualDiskPermissions

Элемент

Описание

items

Массив объектов VirtualDiskPermissionsSubject, каждый из которых содержит информацию об отдельном субъекте (сотруднике, группе или подразделении), имеющем доступ к общему диску.

VirtualDiskPermissionsSubject

Элемент

Описание

rights

Массив прав доступа к общему диску, которые есть у субъекта:

  • read — чтение данных общего диска;
  • write — запись в любом месте общего диска.

type

Тип субъекта:

  • user — сотрудник организации;
  • group — группа;
  • department — подразделение.

id

Идентификатор субъекта:

  • для типа user — идентификатор сотрудника;
  • для типа group — идентификатор группы;
  • для типа department — идентификатор подразделения.

org_id

Идентификатор организации, к которой принадлежит субъект.

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

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

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

  • 400 — Некорректный запрос. / Ошибка инициализации данных пользователя или общего диска.
  • 403 — Доступ к ресурсу запрещен. / Общий диск заблокирован.
  • 405 — Метод запроса не поддерживается.

Метка общего диска. Пример vd_hash: 9Uyws5pZmXgDNA. Метку общего диска можно получить:

  • по API — с помощью метода, который возвращает информацию о статусе создания общего диска;
  • в интерфейсе Яндекс Диска — перейдите в общий диск, метка будет указана в персональной строке после vd/.

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