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