---
schema: rendered-html/v1
title: "Operations with Specific Role | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/operations-api-roles.html
generated_at: 2026-06-11T15:07:35.712144+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- [Operations with Specific Role](operations-api-roles.html)
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. Roles
5. [Operations with Specific Role](#0)

# Operations with Specific Role﻿

Last modified: 24 March 2026

This resource lets you work with roles in YouTrack.

| Resource | ``` /api/roles/{roleID} ``` |
| Returned entity | Role. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/operations-api-roles.html#Role-supported-fields) section. |
| Supported methods | - `POST`: [Update a Specific Role](/help/youtrack/devportal/operations-api-roles.html#update-Role-method). - `GET`: [Read a Specific Role](/help/youtrack/devportal/operations-api-roles.html#get-Role-method). - `DELETE`: [Delete a Specific Role](/help/youtrack/devportal/operations-api-roles.html#delete-Role-method). |

## Role attributes﻿

Represents a role in YouTrack.

### 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. `Read-only`. |
| immutable | Boolean | True if the role is immutable, otherwise false. Immutable roles cannot be updated or deleted. `Read-only`. |

## Update a Specific Role﻿

Update the list of roles.

### Required permissions﻿

Requires Admin Update App permission.

### Request syntax﻿

```
POST /api/roles/{roleID}?{fields}
```

| {roleID} | The database ID of Role |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

## Read a Specific Role﻿

Get a specific role.

### Required permissions﻿

Requires any of the following permissions: Read Role (in at least one scope), Update Organization, or Admin Read App.

### Request syntax﻿

```
GET /api/roles/{roleID}?{fields}
```

| {roleID} | The database ID of the role. |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

## Delete a Specific Role﻿

Delete a specific role.

### Required permissions﻿

Requires Admin Update App permission. Immutable roles cannot be deleted.

### Request syntax﻿

```
DELETE /api/roles/{roleID}
```

| {roleID} | The database ID of the role. |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

- [Operations with Specific Role](/help/youtrack/devportal/operations-api-roles.html)
- [Role attributes](/help/youtrack/devportal/operations-api-roles.html#Role-supported-fields)
- [Update a Specific Role](/help/youtrack/devportal/operations-api-roles.html#update-Role-method)
- [Read a Specific Role](/help/youtrack/devportal/operations-api-roles.html#get-Role-method)
- [Delete a Specific Role](/help/youtrack/devportal/operations-api-roles.html#delete-Role-method)

RolesSaved Queries

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
