Закрытие публичного доступа к ресурсу сотрудника

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

Важно

Для того, чтобы закрыть доступ к ресурсам сотрудников, необходимо указывать в запросах OAuth-токен администратора организации.

В запросе используется публичный ключ, который может принимать одно из значений:

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

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

  • cloud_api:disk.read
  • cloud_api:disk.write
  • cloud_api:disk.app_folder

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

Метод: PUT.

https://cloud-api.yandex.net/v1/disk/public/resources/admin/unpublish
? 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 и возвращает ссылку на опубликованный ресурс в теле ответа (в объекте ResourceUnpublished).

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

{
  "path": "/disk/aa_dir",
  "owner_uid": 1130000066112015
}

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

ResourceUnpublished

Элемент

Описание

path

Полный путь к ресурсу на Диске.

owner_uid

Идентификатор владельца ресурса.

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

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

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

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

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

Например:

  • короткая ссылка (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-формате.

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