Getting information about user permissions for a component

Use this request to view user permissions for a component.

GET

https://api.tracker.yandex.net/v3/components/<component_ID>/permissions/users/<user_login_or_ID>

Query format

Before making a request, get permission to access the API.

To get information about permissions, use an HTTP GET request.

GET v3/components/<component_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 or X-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
<component_ID>	Component ID	Number
<user_login_or_ID>	Unique ID of the account or the user login	String or number

Response format

Request executed successfully

Request failed

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*****
    },
    "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": "Queue"
        },
        "lead": {
            "self": "https://api.tracker.yandex.net/v3/users/8**************4",
            "id": "8**************4",
            "display": "Ivan Ivanov",
            "cloudUid": "ajehs6sinu**********",
            "passportUid": 19692*****
        },
        "assignAuto": false
    },
    "permissions": {
        "CREATE": {
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/5",
                    "id": "5",
                    "display": "All employees"
                }
            ]
        },
        {...}
    }
}

Response parameters

Parameter	Description	Data type
user	Object containing information about the user for whom permissions are being requested	Object
component	Object with component information	Map item
permissions	Array of objects containing information about user permissions for the component. The possible values include: `CREATE`: Create issues. `READ`: View issues. `WRITE`: Edit issues. `DENY`: Access denied. . Permissions can be granted to specific users, groups, or based on user roles.	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

user, users, and lead 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

component object fields

Parameter	Description	Data type
self	Address of the API resource that contains component information	String
id	Component ID	Number
version	Component version. Each change to the component increases the version number	Number
name	Component name	String
queue	Object containing information about the component queue	Map item
lead	Object with information about the component owner	Map item
assignAuto	Assign all the new issues with this component to the component's owner automatically: `true`: Assign `false`: Do not assign	Boolean

queue object fields

Parameter	Description	Data type
self	Address of the API resource with information about the queue.	String
id	Queue ID.	String
key	Queue key.	String
display	Queue name displayed.	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

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.

Was the article helpful?

Editing a component

Getting group permissions for a component