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

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

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

• cloud_api:disk.read

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/public/resources/public-settings
 ? path=<путь к публикуемому ресурсу>
 & [allow_address_access=<признак формата запроса с настройками персонального доступа>]

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

path*

Путь к публикуемому ресурсу. Например, %2Fbar%2Fphoto.png.

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

allow_address_access

Параметр с типом boolean, который обозначает, по какому формату составлен запрос — с настройками персонального доступа или без.

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

• false (значение по умолчанию) — запрос не содержит массив настроек персонального доступа. Значение используется для обеспечения обратной совместимости: для запросов, сформированных по формату предыдущих версий API, в которых нет элементов массива accesses[], query-параметр allow_address_access должен иметь значение false либо отсутствовать.
• true — запрос составлен в формате, который предполагает использование настроек персонального доступа. Применяется, если вы используете текущую версию API и отправляете запрос с телом, в котором содержится массив accesses[].

Чтобы отправлять запросы, которые содержат массив настроек доступа accesses[], у вашего сервиса должна быть возможность и на обработку ответов с этим массивом.

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

Заголовок

Authorization: OAuth <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
    }
  ],
  "available_until": null,
  "password": "absde"
}

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

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 — просмотр.

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

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

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

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

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

Чтобы отправлять запросы, которые содержат массив настроек доступа accesses[], у вашего сервиса должна быть возможность и на обработку ответов с этим массивом.