Получить информацию о правах доступа пользователя к компоненту

Запрос позволяет просмотреть права пользователя относительно компонента.

GET

https://api.tracker.yandex.net/v3/components/<id_компонента>/permissions/users/<логин_или_id_пользователя>

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

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

Для получения информации о правах используйте HTTP-запрос с методом GET.

GET v3/components/<id_компонента>/permissions/users/<логин_или_id_пользователя>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

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

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

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

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

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

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

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

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

Ресурс
Параметр Описание Тип данных
<id_компонента> Идентификатор компонента Число
<логин_или_id_пользователя> Уникальный идентификатор учетной записи или логин пользователя Строка или число

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

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

{
    "user": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 11********
    },
    "component": {
        "self": "https://api.tracker.yandex.net/v3/components/1",
        "id": 1,
        "version": 2,
        "name": "Component 1",
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/TEST",
            "id": "1",
            "key": "TEST",
            "display": "My queue"
        },
        "lead": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
        "assignAuto": false
    },
    "permissions": {
        "CREATE": {
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/5",
                    "id": "5",
                    "display": "All users"
                }
            ]
        },
        ...
    }
}
Параметры ответа
Параметр Описание Тип данных
user Объект с информацией о пользователе, для которого выполняется запрос прав Объект
component Объект с информацией о компоненте Объект
permissions Массив объектов с информацией о доступах пользователя к компоненту. Возможные значения:
  • CREATE— Создание задач;
  • READ— Просмотр задач;
  • WRITE— Редактирование задач;
  • DENY— доступ запрещен
    • .
Доступы могут быть выданы персонально, на группу или в соответствии с ролью		 Массив объектов
users Объект с информацией о пользователе с персональным доступом Объект
groups Объект с информацией о группе, в которую входит пользователь Объект
roles Объект с информацией о роли пользователя, для которой настроен доступ Объект

Поля объектов user, users и lead

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

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о компоненте Строка
id Идентификатор компонента Число
version Версия компонента. Каждое изменение компонента увеличивает номер версии Число
name Название компонента Строка
queue Объект с информацией об очереди компонента Объект
lead Объект с информацией о владельце компонента Объект
assignAuto Автоматически назначить владельца компонента исполнителем для новых задач с этим компонентом:
  • true— назначить;
  • false— не назначать.
 Логический

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

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

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

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

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

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

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

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