Получить информацию о правах доступа группы к компоненту
Запрос позволяет просмотреть права группы относительно компонента.
GET
https://api.tracker.yandex.net/v3/components/<id_компонента>/permissions/groups/<id_группы>
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения информации о правах используйте HTTP-запрос с методом GET
.
GET v3/components/<id_компонента>/permissions/groups/<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
.
{
"group": {
"self": "https://api.tracker.yandex.net/v3/groups/5",
"id": "5",
"display": "All users"
},
"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"
}
]
},
...
}
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
group | Объект с информацией о группе, для которой выполняется запрос прав | Объект |
component | Объект с информацией о компоненте | Объект |
permissions | Массив объектов с информацией о доступах группы к компоненту. Возможные значения:
|
Массив объектов |
groups | Объект с информацией о группе, в которую входит пользователь | Объект |
Поля объектов group
и groups
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о группе | Строка |
id | Идентификатор группы | Строка |
display | Отображаемое название группы | Строка |
Поля объекта component
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о компоненте | Строка |
id | Идентификатор компонента | Число |
version | Версия компонента. Каждое изменение компонента увеличивает номер версии | Число |
name | Название компонента | Строка |
queue | Объект с информацией об очереди компонента | Объект |
lead | Объект с информацией о владельце компонента | Объект |
assignAuto | Автоматически назначить владельца компонента исполнителем для новых задач с этим компонентом:
|
Логический |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объекта lead
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.