Getting information about user permissions for a queue
Use this request to view user permissions for a queue.
GET
https://api.tracker.yandex.net/v3/queues/<queue_ID>/permissions/users/<user_login_or_ID>
To set up queue permissions through the API, use Granting queue access rights requests.
Query format
Before making a request, get permission to access the API.
To get information about permissions, use an HTTP GET
request.
GET v3/queues/<queue_ID>/permissions/users/<user_login_or_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
-
Host
: Address of the node that provides the API. -
Authorization
: Authorization token about these formats:-
OAuth <OAuth_token>
: For authorization using the OAuth 2.0 protocol. Learn more -
Bearer <IAM_token>
: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
-
-
X-Org-ID
orX-Cloud-Org-ID
: Organization ID.-
Use the
X-Org-ID
header if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-ID
header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Resource
Parameter | Description | Data type |
---|---|---|
<queue_ID> | Queue ID or key. The queue key is case-sensitive | String or number |
<user_login_or_ID> | Unique ID of the account or the user login | String or number |
Response format
If the request is successful, the API returns a response with code 200 OK
.
{
"user": {
"self": "https://api.tracker.yandex.net/v3/users/8**************4",
"id": "8**************4",
"display": "Ivan Ivanov",
"cloudUid": "ajehs6sinu**********",
"passportUid": 19692*****
},
"permissions": {
"CREATE": {
"users": [
{
"self": "https://api.tracker.yandex.net/v3/users/8000000000000004",
"id": "8**************4",
"display": "Ivan Ivanov",
"cloudUid": "ajehs6sinu**********",
"passportUid": 19692*****
}
],
"groups": [
{
"self": "https://api.tracker.yandex.net/v3/groups/5",
"id": "5",
"display": "All employees"
}
],
"roles": [
{
"self": "https://api.tracker.yandex.net/v3/roles/queue-lead",
"id": "queue-lead",
"display": "Queue owner"
}
]
},
{...},
},
"components": [
{
"self": "https://api.tracker.yandex.net/v3/components/1",
"id": "1",
"display": "Component 1"
},
{...}
]
}
Response parameters
Parameter | Description | Data type |
---|---|---|
user | Object containing information about the user for whom permissions are being requested | Map item |
permissions | Array of objects containing information about user permissions for the queue. The possible values include:
|
Array of objects |
users | Object containing information about the user with personal access | Map item |
groups | Object containing information about the group to which the user belongs | Map item |
roles | Object containing information about the user role for which access has been set up | Map item |
components | Array of objects containing information about the components to which the user has access | Array of objects |
user
and users
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user | String |
id | User ID. | String |
display | Displayed user name | String |
passportUid | Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. | Number |
cloudUid | Unique user ID in Yandex Cloud Organization | String |
groups
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource that contains information about the group to which the user belongs | String |
id | ID of the group to which the user belongs | String |
display | Display name of the group to which the user belongs | String |
roles
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource that contains information about the user role | String |
id | User role ID | String |
display | Display name of the user role | String |
components
object fields
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource that contains component information | String |
id | Component ID | String |
display | Component display name | String |
If the request is processed incorrectly, the API returns a response with an error code:
- 401
- The user is not authorized. Make sure that actions described in the API access section are performed.
- 403
- You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
- 404
- The requested object was not found. You may have specified an invalid object ID or key.