Last updated Jul 16, 2024

Jira Service Management Incident API scopes for OAuth 2.0 (3LO) and Forge apps

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

Jira Service Management Incident API permissions also control access to data and aren't overridden by scopes. For example, if a user does not have Jira Administrator Global permission or Team Admin rights then the Create Incident operation won’t be able to create schedule even if the app has the write:incident:jira-service-management scope.

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.

This process does not remove any redundant scopes from the manifest file, and these scopes need to be removed manually.

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

Review your app to determine all of the operations used.
Consult the Jira Service Management Incident 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 while remembering to remove any deprecated scopes.

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 Service Management Incidents 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.

Scope name	Summary	Description
`read:incident:jira-service-management`	Read Jira Service Management Incident entities	Read incidents & entities associated with incidents like affected services, linked alerts, request status, chat channels, post-incident-review, responders & stakeholders.
`write:incident:jira-service-management`	Create, update & delete Jira Service Management Incident entities	Create, update & delete incidents & entities associated with incidents like affected services, linked alerts, request status, chat channels, post-incident-review, responders & stakeholders.