Получить права доступа к сущности

Запрос возвращает прямые права доступа к цели, проекту или портфелю проектов.

GET

https://api.tracker.yandex.net/v3/entities/{тип_сущности}/{id_сущности}/permissions

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

Перед выполнением запроса получите доступ к API.

GET /v3/entities/{тип_сущности}/{id_сущности}/permissions
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth OAUTH_TOKEN при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer IAM_TOKEN при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
тип_сущности Тип сущности:
  • project — проект;
  • portfolio — портфель;
  • goal — цель
 Строка
id_сущности Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. В качестве идентификатора можно использовать параметр id или shortId. Строка

В параметре {id_сущности} можно использовать значение id или shortId.

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

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

API возвращает объект с правами доступа. Свойства READ, GRANT и WRITE находятся в корне ответа. В ответ не входят acl, permissionSources и parentEntities.

{
    "READ": {
        "users": [],
        "groups": [],
        "roles": []
    },
    "GRANT": {
        "users": [],
        "groups": [],
        "roles": ["AUTHOR", "OWNER"]
    },
    "WRITE": {
        "users": [],
        "groups": [],
        "roles": ["CLIENT", "AUTHOR", "FOLLOWER", "OWNER", "MEMBER"]
    }
}
Параметры ответа
Параметр Описание Тип данных
READ Объект с пользователями, группами и ролями, которые могут просматривать сущность Объект
GRANT Объект с пользователями, группами и ролями, которые могут изменять настройки доступа к сущности Объект
WRITE Объект с пользователями, группами и ролями, которые могут редактировать сущность Объект

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

Параметр

Описание

Тип данных

users

Список пользователей с этим типом доступа

Массив объектов

groups

Список групп с этим типом доступа

Массив объектов

roles

Список ролей сущности с этим типом доступа:

  • AUTHOR — Автор;
  • OWNER — Ответственный;
  • CLIENT — Заказчики;
  • FOLLOWER — Наблюдатели;
  • MEMBER — Участники

Массив строк

Поля объектов в массиве users

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Identity Hub. Строка

Поля объектов в массиве groups

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о группе пользователей Строка
id Идентификатор группы Строка
display Отображаемое имя группы Строка

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

401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

Чтобы получить расширенные настройки доступа, включая наследование прав, используйте запрос Получить расширенные настройки доступа сущности.

Портфель — это инструмент для объединения проектов и других портфелей по продукту, отделу или другому признаку.

Когда у вас несколько параллельных проектов, портфель позволяет взглянуть на них с высоты: как распределены ресурсы, где сроки подходят к концу.

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

Проект помогает отслеживать: сколько задач сделано, сколько осталось, укладывается ли команда в сроки.

Цель — это стратегия развития или желаемый итог работы команды. Прогресс цели оценивают в количественных показателях. К цели можно привязать проекты, портфели и задачи, чтобы видеть, какая работа ведется для ее достижения.

Предыдущая
Получить расширенные настройки доступа
Следующая
Изменить расширенные настройки доступа