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

Role

Represents a role in YouTrack.

Available since YouTrack 2026.1.

Attributes

This table describes attributes of the Role 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 role. `Read-only`.
name	String	The name of the role.
description	String	The description of the role. `Can be null`.
permissions	Array of Permissions	The list of permissions included in the role. To set or replace the role's permissions, include this attribute in the POST request body. Specify each permission key in a permission object's `id` attribute. `Read-only`.
immutable	Boolean	True for the System Admin role, otherwise false. An immutable role cannot be updated or deleted. `Read-only`.

02 November 2026