Получение списка всех настроек доступа к публичному ресурсу по публичному ключу ресурса или его url

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

• короткая ссылка;
• полная ссылка;
• хеш.

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

• cloud_api:disk.read

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/public/resources/admin/public-settings
 ? public_key=<ключ или публичный URL ресурса>

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

public_key*

Ключ опубликованного ресурса или публичная ссылка на ресурс.

Например:

• короткая ссылка (https://disk.yandex.ru/d/446d6f44-bb36-48bb-973c-4e1c71e33ccd);
• полная ссылка (https://disk.yandex.ru/public/?hash=dAEMkc1QDY4SPb5%2BBlFnEKkx1oWX7/p5zYSCvHGQ5/6FQeE4ICFyXScld621gdJYq/J6bpmRyOJonT3VoXnDag%3D%3D);
• хеш (dAEMkc1QDY4SPb5+BlFnEKkx1oWX7/p5zYSCvHGQ5/6FQeE4ICFyXScld621gdJYq/J6bpmRyOJonT3VoXnDag==).

Значение параметра следует кодировать в URL-формате.

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

Заголовок

Authorization: OAuth <token>

где <token> — токен администратора организации.

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

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

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

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

{
  "accesses": [
    {
      "id": 1130000066112015,
      "type": "user",
      "rights": [
        "read"
      ],
      "org_id": 8012499
    },
    {
      "id": 32,
      "type": "group",
      "rights": [
        "write"
      ],
      "org_id": 8012499
    },
    {
      "rights": [
        "read_with_password_without_download"
      ],
      "org_id": 8012499,
      "type": "macro",
      "macros": [
        "employees"
      ]
    },
    {
      "id": 8,
      "type": "group",
      "rights": [
        "write"
      ],
      "org_id": 8012499
    },
    {
      "id": 1130000066115011,
      "type": "owner",
      "rights": [
        "write"
      ],
      "org_id": 8012499
    }
  ],
  "available_until": null
}

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

PublicSettings

PublicAccesses

• Общий доступ ("type": "macro")

  Элемент	Описание
  macros	Массив, который содержит информацию о том, будет ли общий доступ к ресурсу с указанными правами предоставлен только внутри организации или для любых пользователей. Возможные значения: employees — общий доступ к ресурсу только внутри определенной организации; all — общий доступ для всех пользователей.
  org_id	Идентификатор организации, сотрудникам которой предоставляется общий доступ к ресурсу с правами, указанными в параметре rights данного объекта. Указывается, только если параметр macros имеет значение employees.
  type	Уровень права доступа: macro — общий доступ.
  rights	Права доступа к ресурсу. Возможные значения: write — редактирование; read — просмотр; read_without_download — просмотр без возможности скачивания; read_with_password — просмотр с доступом по паролю; read_with_password_without_download — просмотр с доступом по паролю без возможности скачивания.

• Персональный доступ для сотрудников ("type": "user")

  Элемент	Описание
  id	Уникальный идентификатор (uid) сотрудника организации, которому предоставлен персональный доступ к ресурсу с правами, указанными в параметре rights данного объекта.
  org_id	Идентификатор организации, к которой относится сотрудник.
  type	Уровень права доступа: user — персональный доступ для сотрудника организации.
  rights	Права доступа к ресурсу. Возможные значения: write — редактирование; read — просмотр.

• Персональный доступ для групп ("type": "group")

  Элемент	Описание
  id	Уникальный идентификатор (id) группы в организации, которой предоставлен персональный доступ к ресурсу с правами, указанными в параметре rights данного объекта.
  org_id	Идентификатор организации, которой принадлежит группа.
  type	Уровень права доступа: group — персональный доступ для группы.
  rights	Права доступа к ресурсу. Возможные значения: write — редактирование; read — просмотр.

• Персональный доступ для подразделений ("type": "department")

  Элемент	Описание
  id	Уникальный идентификатор (id) подразделения в организации, которому предоставлен персональный доступ к ресурсу с правами, указанными в параметре rights данного объекта.
  org_id	Идентификатор организации, которой принадлежит подразделение.
  type	Уровень права доступа: department — персональный доступ для подразделения.
  rights	Права доступа к ресурсу. Возможные значения: write — редактирование; read — просмотр.

• Доступ для владельца ("type": "owner")

  Элемент	Описание
  id	Уникальный идентификатор (uid) сотрудника организации — владельца публичного ресурса.
  org_id	Идентификатор организации, к которой относится сотрудник.
  type	Уровень права доступа: owner — доступ для владельца ресурса.
  rights	Права доступа к ресурсу. Всегда write — редактирование.

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

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

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

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