Редактирование доступов к общему диску

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

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

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

  • cloud_api:disk.write

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

Метод: PATCH.

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

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

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

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

Authorization: OAuth <token>
Content-Type: application/json

Тело запроса

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

Элемент

Тип данных

Описание

items

array

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

Метод PATCH при повторном использовании для одного и того же общего диска не изменяет весь список ранее заданных объектов целиком, а обновляет только те объекты, которые в нем передаются. То есть:

  • для изменения прав субъекта (сотрудника, группы или подразделения) отправьте в запросе только описывающий его объект VirtualDiskPermissionsSubject с новым списком прав;
  • для удаления прав доступа субъекта к общему диску отправьте объект VirtualDiskPermissionsSubject с пустым списком в поле rights.

VirtualDiskPermissionsSubject

Элемент

Тип данных

Описание

rights

array

Массив прав доступа к общему диску, которые назначаются субъекту:

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

type

string

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

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

id

integer

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

  • для типа user — идентификатор сотрудника;
  • для типа group — идентификатор группы;
  • для типа department — идентификатор подразделения.
Как получить идентификаторы сотрудников, групп и подразделений организации

  • С помощью API Яндекс 360 для бизнеса. Описания методов приведены в разделах:

    • Сотрудники — идентификаторы сотрудников возвращаются в ответе на запрос в поле id массива users.
    • Группы — идентификаторы групп возвращаются в ответе на запрос в поле id массива groups.
    • Подразделения — идентификаторы подразделений возвращаются в ответе на запрос в поле id массива departments.

  • Идентификаторы сотрудников также можно получить через интерфейс кабинета организации Яндекс 360 для бизнеса https://admin.yandex.ru:

    1. Выберите Пользователи → Сотрудники.
    2. Найдите строчку нужного сотрудника и нажмите на его имя.
    3. Правой кнопкой нажмите на логин сотрудника и скопируйте адрес ссылки.
    4. Вставьте адрес в любой текстовый редактор. Идентификатор сотрудника — это часть адреса после uid=.

org_id

integer

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

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

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

Если запрос был обработан без ошибок, права доступа изменяются и API отвечает кодом 200 OK.

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

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

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

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

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

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

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

Предыдущая
Список доступов к общему диску
Следующая
Удаление общего диска