llms.txt: machine-readable documentation index. Markdown version of this page is also available.

YouTrack Developer Portal Help

Operations with Specific AssignedRole

This resource lets you work with roles assigned to a user or a group in YouTrack.

Available since YouTrack 2026.1.

Resource

/api/assignedRoles/{roleID}

Returned entity

AssignedRole. For the description of the entity attributes, see Supported Fields section.

Supported methods

AssignedRole attributes

Represents a role assigned to a user or a group in a specific scope.

Available since YouTrack 2026.1.

Attributes

This table describes attributes of the AssignedRole entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The database ID of the assigned role. Read-only.

role

Role

The role that is assigned.

scope

AccessScope

The scope where the role is assigned. Possible values: Global, Organization, or Project.

holder

The user or group that holds the role. Set this attribute when creating an assignment. Read-only.

Read a Specific AssignedRole

Get a specific assigned role.

Required permissions

Requires Read permission in the scope of the assigned role (Low-level Admin Read, Read Organization, or Read Project).

Request syntax

GET /api/assignedRoles/{roleID}?{fields}

{roleID}

The database ID of the assigned role.

Request parameters

Parameter

Type

Description

fields

String

A list of AssignedRole attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Read assignment 31-70. Use the assignment database ID returned when you assign a role.

Sample request

curl --get https://example.youtrack.cloud/api/assignedRoles/31-70 \ --data-urlencode 'fields=id,role(id,name),scope(id,$type),holder(id,$type)' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <permanent_token>'

Sample response body

{ "role": { "name": "Issue Reader", "id": "28-33" }, "scope": { "id": "549-0", "$type": "ProjectScope" }, "holder": { "id": "24-2", "$type": "User" }, "id": "31-70" }

Revoke a Role from a User or a Group

Revokes a specific assigned role from a user or a group.

Required permissions

Requires Update permission in the scope of the assigned role (Low-level Admin Write, Update Organization, or Update Project).

Request syntax

DELETE /api/assignedRoles/{roleID}

{roleID}

The database ID of the assigned role.

Request parameters

Parameter

Type

Description

fields

String

A list of AssignedRole attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Revoke assignment 31-70.

Sample request

curl --request DELETE https://example.youtrack.cloud/api/assignedRoles/31-70 \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <permanent_token>'
02 November 2026