# Permissions and Scopes JiraTUI requires that your Jira user account has specific permissions configured before you can use the tool. These permissions (called "scopes" in Jira) are not set by JiraTUI—your organization's Jira administrator must grant them to your user account. # What are scopes? Scopes define what actions a user or application can perform on Jira. For example, one scope might allow reading issues, while another allows creating them. Think of them as a granular permission system. # Cloud vs. On-Premises Jira The way you authenticate differs depending on your setup: - Jira Cloud: Uses [OAuth 2.0 scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/). For more details, refer to [Jira Cloud Platform API v3 - Authentication](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#other-integrations) if your organization uses jira Cloud v3 or, [Jira Cloud Platform API v2 - Authentication](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#about) if your organization uses jira Cloud v2. - Jira Server (On-Premises): Uses [basic authentication](https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/). See the linked documentation for details. # Required Scopes JiraTUI uses the Jira APIs listed below, each with specific scope requirements: - [Jira Cloud Platform API v2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#about) and [v3](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#about). - [Jira Software Cloud API](https://developer.atlassian.com/cloud/jira/software/rest/intro/#introduction) and [Jira Software scopes for OAuth 2.0 (3LO)](https://developer.atlassian.com/cloud/jira/software/scopes-for-oauth-2-3LO-and-forge-apps/). - [Jira Server API](https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/) # Scopes by Use Case ## When Connecting to Jira Cloud v2/v3 If you connect to Jira Cloud v2/v3 then most JiraTUI use cases require: - `read:jira-work` - `read:jira-user` - `write:jira-work` - `manage:jira-configuration` - `read:sprint:jira-software` - `read:board-scope:jira-software` - `read:project:jira` The table below details the scopes needed for each specific use case when you connect to Jira Cloud v3. Work with your Jira administrator to ensure your account has the appropriate scopes assigned. | API Operation | Recommended Permission Scopes | Granular Permission Scopes | Related Use Cases | |----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| | Get projects paginated | [read:jira-work](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#scopes) | `read:issue-type:jira`, `read:project:jira`, `read:project.property:jira`, `read:user:jira`, `read:application-role:jira`, `read:avatar:jira`, `read:group:jira`, `read:issue-type-hierarchy:jira`, `read:project-category:jira`, `read:project-version:jira`, `read:project.component:jira` | Populate Project Filter, Populate Work Item Types Filter | | Get all statuses for project | `read:jira-work` | `read:issue-status:jira`, `read:issue-type:jira`, `read:status:jira ` | Populate Work Item Status Filter | | Get all issue types for user | `read:jira-work` | `read:issue-type:jira`, `read:avatar:jira`, `read:project-category:jira`, `read:project:jira` | Populate Work Item Types Filter | | Get all statuses | `read:jira-work` | `read:status:jira` | Populate Work Item Status Filter | | Get project | `read:jira-work` | `read:issue-type:jira`, `read:project:jira`, `read:project.property:jira`, `read:user:jira`, `read:application-role:jira`, `read:avatar:jira`, `read:group:jira`, `read:issue-type-hierarchy:jira`, `read:project-category:jira`, `read:project-version:jira`, `read:project.component:jira` | Populate Work Item Types Filter | | Find users assignable to issues | [read:jira-user](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#scopes) | `read:issue:jira`, `read:project:jira`, `read:user:jira`, `read:application-role:jira`, `read:avatar:jira`, `read:group:jira` | Search Assignee, Search Reporter, Update Work Item, Create Work Item | | Get issue | `read:jira-work` | `read:issue-meta:jira`, `read:issue-security-level:jira`, `read:issue.vote:jira`, `read:issue.changelog:jira`, `read:avatar:jira`, `read:issue:jira`, `read:status:jira`, `read:user:jira`, `read:field-configuration:jira` | Delete Attachment, Link Work Items, Retrieve Work Item Worklogs, Retrieve Work Item, Work Item Quick View, Update Work Item | | Get issue picker suggestions | `read:jira-work` | `read:issue-details:jira` | Search Users | | Create or update remote issue link | [write:jira-work](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#scopes) | `write:issue:jira`, `write:issue.remote-link:jira`, `read:issue.remote-link:jira` | Create Work Item Web Links | | Delete remote issue link by ID | `write:jira-work` | `delete:issue.remote-link:jira`, `write:issue:jira` | Delete Work Item Web Link | | Search for issues using JQL enhanced search | `read:jira-work` | `read:issue-details:jira`, `read:field.default-value:jira`, `read:field.option:jira`, `read:field:jira`, `read:group:jira` | Search Work Items | | Count issues using JQL | `read:jira-work` | `read:issue-details:jira`, `read:field.default-value:jira`, `read:field.option:jira`, `read:field:jira`, `read:group:jira` | Search Work Items | | Get global settings | `read:jira-user` | `read:instance-configuration:jira`, `read:issue.time-tracking:jira` | Show Server Information | | Get Jira instance info | `read:jira-user` | `read:instance-configuration:jira`, `read:issue.time-tracking:jira` | Show Server Information | | Get current user | `read:jira-user` | `read:application-role:jira`, `read:group:jira`, `read:user:jira`, `read:avatar:jira` | Show User Information | | Bulk get groups | `read:jira-user` | `read:group:jira` | CLI: Search User Groups | | Get users from group | [manage:jira-configuration](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#scopes) | `read:group:jira`, `read:user:jira`, `read:avatar:jira` | CLI: Show Total Users in Group | | Get user | `read:jira-user` | `read:application-role:jira`, `read:group:jira`, `read:user:jira`, `read:avatar:jira` | Create Work Item, Search Users | | Add comment | `write:jira-work` | `read:comment:jira`, `read:comment.property:jira`, `read:group:jira`, `read:project:jira`, `read:project-role:jira`, `read:user:jira`, `write:comment:jira`, `read:avatar:jira` | Add Comment | | Get comment | `read:jira-work` | `read:comment:jira`, `read:comment.property:jira`, `read:group:jira`, `read:project:jira`, `read:project-role:jira`, `read:user:jira`, `read:avatar:jira` | Retrieve Work Item Comment | | Get comments | `read:jira-work` | `read:comment:jira`, `read:comment.property:jira`, `read:group:jira`, `read:project:jira`, `read:project-role:jira`, `read:user:jira`, `read:avatar:jira` | Retrieve Work Item Comments | | Delete comment | `write:jira-work` | `delete:comment:jira`, `delete:comment.property:jira` | Delete Comment | | Get edit issue metadata | `read:jira-work` | `read:issue-meta:jira`, `read:field-configuration:jira` | Update Work Item | | Edit issue | `write:jira-work` | `write:issue:jira` | Update Work Item | | Create issue | `write:jira-work` | `write:issue:jira`, `write:comment:jira`, `write:comment.property:jira`, `write:attachment:jira`, `read:issue:jira` | Create Work Item | | Delete issue | `write:jira-work` | `delete:issue:jira ` | Delete Work Item | | Get transitions | `read:jira-work` | `read:issue.transition:jira`, `read:status:jira`, `read:field-configuration:jira` | Update Work Item | | Transition issue | `write:jira-work` | `write:issue:jira`, `write:issue.property:jira` | Update Work Item | | Create issue link | `write:jira-work` | `write:comment:jira`, `write:issue:jira`, `write:issue-link:jira` | Create Link Between Work Items | | Get issue link types | `read:jira-work` | `read:issue-link-type:jira` | Create Link Between Work Items | | Delete issue link type | `manage:jira-configuration` | `delete:issue-link-type:jira` | Delete Link Between Work Items | | Get create field metadata fora project and issue type id | `read:jira-work` | `read:issue-meta:jira`, `read:avatar:jira`, `read:field-configuration:jira` | Create Work Item | | Add attachment | `write:jira-work` | `read:user:jira`, `write:attachment:jira`, `read:attachment:jira`, `read:avatar:jira` | Attach Files to Work Items | | Delete attachment | `write:jira-work` | `delete:attachment:jira` | Delete Attachment | | Get attachment metadata | `read:jira-work` | `read:attachment:jira`, `read:user:jira`, `read:application-role:jira`, `read:avatar:jira`, ``read:group:jira`` | Retrieve Work Item Attachments | | Get attachment content | `read:jira-work` | `read:attachment:jira` | Retrieve Work Item Attachment | | Get issue worklogs | `read:jira-work` | `read:group:jira`, `read:issue-worklog:jira`, `read:issue-worklog.property:jira`, `read:project-role:jira`, `read:user:jira`, `read:avatar:jira` | Retrieve Work Item Worklogs | | Add worklog | `write:jira-work` | `write:issue-worklog:jira`, `write:issue-worklog.property:jira`, `read:avatar:jira`, `read:group:jira`, `read:issue-worklog:jira`, `read:project-role:jira`, `read:user:jira`, `read:issue-worklog.property:jira` | Add Worklog to Work Items | | Update worklog | `write:jira-work` | `read:comment:jira`, `read:group:jira`, `read:issue-worklog:jira`, `read:issue-worklog.property:jira`, `read:project-role:jira`, `read:user:jira`, `write:comment:jira`, `write:issue-worklog:jira`, `write:issue-worklog.property:jira`, `read:avatar:jira` | Update Work Item Worklog | | Delete worklog | `write:jira-work` | `delete:issue-worklog:jira`, `delete:issue-worklog.property:jira`, `write:issue.time-tracking:jira` | Delete Work Item Worklog | | Get fields | `read:jira-work` | `read:field:jira`, `read:avatar:jira`, `read:project-category:jira`, `read:project:jira`, `read:field-configuration:jira ` | Flag Work Items, Retrieve Work Item Flag | | Get field auto complete suggestions | `read:jira-work` | `read:issue-details:jira` | Update Work Item Labels | | Get all the boards in a project | `read:board-scope:jira-software`, `read:project:jira` | | View and Update the sprint of work items | | Get all the sprints in a project board | `read:sprint:jira-software` | | View and Update the sprint of work items |