Изменить права доступа к дашборду

Запрос выдает или отзывает права доступа к дашборду. Для выполнения запроса требуется право GRANT.

PATCH

https://api.tracker.yandex.net/v3/dashboards/{id_дашборда}/permissions?version=DASHBOARD_VERSION

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

Перед выполнением запроса получите доступ к API. Передайте текущую версию дашборда в параметре version или заголовке If-Match.

PATCH /v3/dashboards/{id_дашборда}/permissions?version=DASHBOARD_VERSION
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

{
  "grant": {
    "READ": {"users": [{"id": "USER_ID"}], "groups": [], "roles": []}
  },
  "revoke": {
    "WRITE": {"users": [], "groups": [{"id": "GROUP_ID"}], "roles": []}
  }
}

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее
Content-Type: формат тела запроса. Должен иметь значение application/json.
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

Параметр	Описание	Тип данных
id_дашборда	Идентификатор дашборда.	Число

Параметры запроса

Передайте версию дашборда в параметре version или заголовке If-Match.

Параметр	Описание	Тип данных
version	Текущая версия дашборда. Укажите, если не передали заголовок `If-Match`.	Число

Дополнительные заголовки

Заголовок	Описание
If-Match	Текущая версия дашборда в двойных кавычках, например `"4"`. Укажите, если не передали параметр `version`.

Параметры тела запроса

Параметр	Описание	Тип данных
grant	Права, которые нужно выдать.	Объект
revoke	Права, которые нужно отозвать.	Объект

Поля объектов grant и revoke

Параметр	Описание	Тип данных
READ	Право просмотра.	Объект
WRITE	Право изменения.	Объект
GRANT	Право управления доступом.	Объект

Поля объектов READ, WRITE и GRANT

Параметр	Описание	Тип данных
users	Пользователи с указанным правом. В каждом объекте укажите `id`.	Массив объектов
groups	Группы с указанным правом. В каждом объекте укажите `id`.	Массив объектов
roles	Системные роли с указанным правом. Передайте массив строк, например `["OWNER"]`.	Массив строк

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

При успехе API возвращает обновленный объект прав доступа.

{
  "acl": {
    "READ": {
      "users": [],
      "groups": [
        {
          "self": "https://api.tracker.yandex.net/v3/groups/3",
          "id": "3",
          "display": "Все сотрудники"
        }
      ],
      "roles": []
    },
    "WRITE": {
      "users": [
        {
          "self": "https://api.tracker.yandex.net/v3/users/1234567890",
          "id": "1234567890",
          "display": "Пользователь"
        }
      ],
      "groups": [],
      "roles": [
        {
          "id": "OWNER",
          "name": "Владелец"
        }
      ]
    },
    "GRANT": {
      "users": [],
      "groups": [],
      "roles": [
        {
          "id": "OWNER",
          "name": "Владелец"
        }
      ]
    }
  }
}

Параметры ответа

Параметр	Описание	Тип данных
acl	Действующие права доступа.	Объект
inheritedFrom	Источник унаследованных прав. Если права заданы на самом дашборде, поле отсутствует.	Объект

Поля объекта acl

Параметр	Описание	Тип данных
READ	Субъекты с правом просмотра.	Объект
WRITE	Субъекты с правом изменения. Также получают право `READ`.	Объект
GRANT	Субъекты с правом управления доступом.	Объект

Поля объектов READ, WRITE и GRANT

Параметр	Описание	Тип данных
users	Ссылки на пользователей. Поля объекта пользователя.	Массив объектов
groups	Ссылки на группы с полями `self`, `id` и `display`.	Массив объектов
roles	Системные роли с полями `id` и `name`.	Массив объектов

Поля элементов массива groups

Параметр	Описание	Тип данных
self	Адрес ресурса API группы.	Строка
id	Идентификатор группы.	Строка
display	Название группы.	Строка

Поля элементов массива roles

Параметр	Описание	Тип данных
id	Идентификатор системной роли, например `OWNER`.	Строка
name	Название роли.	Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400: Один или несколько параметров запроса имеют недопустимое значение.

Некорректный формат тела запроса или заголовка If-Match, либо права дашборда наследуются.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

Нет права GRANT на дашборд.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

412: При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.

422: Ошибка валидации JSON, запрос отклонен.

Пользователь или группа не найдены.

428: Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.

Не переданы ни version, ни If-Match.

Была ли статья полезна?

Получить права доступа к дашборду

Создать виджет