Last updated Nov 21, 2024

Jira Software scopes for OAuth 2.0 (3LO) and Forge apps

Scopes enable an app to request a level of access to an Atlassian product.

Jira Software permissions also control access to data and aren’t overridden by scopes. For example, if a user does not have project admin permissions then viewing the board configuration won’t be able to access board configuration data even if the app has the read:board-scope.admin:jira-software scope.
The scopes may provide the potential to access beta or non-public APIs that are later changed or removed from the Atlassian product. The inclusion of the API endpoint in a scope doesn't imply that the product makes this endpoint public. Read the Jira Software REST API documentation for details.
Some scopes automatically imply that the app is granted other scopes.

Setting your app's scopes

Forge apps

The easiest way to set your app's scopes is to:

Update to the latest forge-cli packages.
Run forge lint --fix to add the scopes to the manifest.

If you want to set the scopes manually, you need to:

Review your app to determine all of the operations used.
Consult the Jira Software Cloud REST API documentation to determine the scope needed for each operation and create a list of scopes.
Add the scopes required to the app's manifest file.

OAuth 2.0 apps

For OAuth 2.0 apps, you need to:

Review your app to determine all of the operations used.
Consult the Jira Software Cloud REST API documentation to determine the scope needed for each operation and create a list of scopes.
Update the scopes required in the developer console.

Scopes

These scopes are for apps using OAuth 2.0 authorization code grants (3LO) for authorization and Forge apps. The title and description are displayed to the user on the consent screen during the authorization flow.

Scopes for Atlassian Connect are different. See Scopes for Connect apps to know more.

Classic scopes

Jira Software doesn’t support classic scopes. Use granular scopes instead.

Granular scopes

Scope name	Title	Description
`write:board-scope.admin:jira-software`	Create and update board configuration	Create and update the configuration and project for a board. View and update features, filters, properties, and quick filters for a board.
`delete:board-scope.admin:jira-software`	Delete board configuration	Delete board configuration settings, features, and properties.
`read:board-scope.admin:jira-software`	View board configuration	View the configuration, project features, filters, properties, and quick filters for a board.
`write:board-scope:jira-software`	Move issues between boards and backlogs	Move issues to a backlog and from a backlog to a board.
`read:board-scope:jira-software`	View boards, backlogs, and related items	View boards, issues on a board, issues from a backlog, reports, and versions.
`write:epic:jira-software`	Update epics	Remove issues from epic, move issues to epic, rank epics, and partially update epics.
`read:epic:jira-software`	View epics and related issues	View and search for epics, and issues related to an epic.
`write:issue:jira-software`	Rank and estimate issues	Move (rank) issues and update issue estimates.
`read:issue:jira-software`	View issues	View issues, issue estimations, and the field used for estimations.
`write:sprint:jira-software`	Update and delete sprints	Update sprints, move issues to sprints, and update the order of sprints.
`delete:sprint:jira-software`	Delete sprints	Delete sprints and their properties.
`read:sprint:jira-software`	View sprints	View sprints and sprint related issues and properties.
`write:source-code:jira-software`	Create, update, and delete repositories	Create, update, and delete development information, delete repository and development information entities.
`read:source-code:jira-software`	View repositories	View repositories and check if data exists for the supplied properties.
`write:feature-flag:jira-software`	Create, update, and delete feature flags	Create, update, and delete feature flags.
`read:feature-flag:jira-software`	View feature flags	View feature flags.
`write:deployment:jira-software`	Create, update, and delete deployments	Create, update, and delete deployments.
`read:deployment:jira-software`	View deployments	View deployments.
`write:build:jira-software`	Create, update, and delete builds	Create, update, and delete builds.
`read:build:jira-software`	View builds	View builds.
`write:remote-link:jira-software`	Create, update and delete links	Create, update and delete links.
`read:remote-link:jira-software`	View remote links	View remote links.