How to Create an JIRA App to be compatible with OAuth2

[christianarty]

For the jira-cli to use the Cloud OAuth solution, you must create a JIRA App, with the appropriate scopes and matching callback url for it to work properly.

Steps

Creating a JIRA OAuth 2.0 App

1. Navigate to Developer Console on Atlassian's Developer Portal
2. Create a New OAuth 2.0 Integration app
3. Name your application whatever you'd like and continue
4. You should be on a page like this:

Enabling OAuth 2.0 for your app

1. On the side panel, Click on Authorization, should land on this page below:

2. Click on Add for the OAuth 2.0 (3LO) Authorization type, it should then prompt you for a callback url:

The default callback url for this in the jira-cli is http://localhost:9876/callback. You should use this but if you want the server to run at a different url, feel free to change it but make sure the change is reflected when you run jira init

3. Enter the callback url and Save Changes

Adding the proper scopes to your app

1. Click on the Permissions tab on the side panel, should end up here:

The minimum required scopes to enable are these:

// Classic scopes
"read:jira-user",
"read:jira-work",
"write:jira-work",
// Granular scopes
"read:board-scope:jira-software", 
"read:project:jira",
"read:sprint:jira-software",
"read:issue-details:jira",
"read:jql:jira",
"write:sprint:jira-software"

All of these exist on the JIRA API scope.

2. Click on Add for the JIRA API scope and then configure to add the scopes.
3. Click on Edit Scopes and add the scopes detailed above and save

Note

Everything except for read:jira-user, read:jira-work, write:jira-work scopes are granular scopes, so you need to go to another tab to enable it.

Your JIRA App should be ready. The only thing to note down is the Client ID and Client Secret. These values are unique to your app.

Get your Client ID and Secret

1. Click on the Settings tab on the left panel
2. Scroll to the bottom to see your generated id and client secret
3. Note these down/ Keep this page open for easy access for when the jira-cli asks for these values when you run jira init

[christianarty]

Note, just edited this post today to include more scopes for jira sprint list to work properly: #877 (comment)