Jira - Migrate to new scopes for API Integration

Jira has updated their scopes and as a result, you will need to update the scopes for your existing Jira connector for Zilla. You can read about this here https://community.developer.atlassian.com/t/action-required-update-scopes-for-forge-and-oauth-2-0-3lo-apps/53299

Step-by-Step instructions to migrate Jira scopes

1. Navigate to https://developer.atlassian.com/console/myapps/

2. Click on the existing Jira Connector for Zilla which may look something like:

   Open

   

    

3. Click on Permissions from the left hand side menu:

   Open

   

    

4. We want to make sure that we are only using the Jira API, and that the rest of the APIs (User Identity API, Confluence API and Personal data reporting API) are not used. To do this, follow these steps:

   1. User identity API - If the User identity API has the Configure button against it, then click on Configure, otherwise if it says Add, then leave it as is and move on to #b.

      1. Once you click on Configure, you will see a page like this:

          

      2. We need to make sure that there are no scopes enabled here. Click on Edit Scopes, deselect all scopes and Save.

      3. Double check that all scopes are removed.

   2. Confluence API - If the Confluence API has the Configure button against it, then click on Configure, otherwise if it says Add, then leave it as is and move on to #c.

      1. Once you click on Configure, you will see a page like this:

      2. We need to make sure that there are no scopes enabled here. Click on Edit Scopes, deselect all scopes and Save.

          

      3. Double check that all scopes are removed.

   3. Jira API - If the Jira API has the Configure button against it, then click on Configure, otherwise if it says Add, then click on Add and then click on Configure.

      1. Once you click on Configure, you will see a page like this:

          

      2. We first need to make sure that none of the older scopes are enabled here. Click on Edit Scopes, deselect all scopes and Save.

          

      3. You will be redirected back to Permissions page.

          

      4. Click on Add and then click on Configure again. You will now see the new Jira scopes.

      5. We need to make sure that only the required scopes are enabled here. Click on Edit Scopes, select the following scopes and Save (you can user the filters provided here):

         1. View users: read:user:jira

         2. View application roles: read:application-role:jira

         3. View system and custom avatars: read:avatar:jira

         4. View user groups: read:group:jira

             

      6. Double check that only the required scopes are enabled.

          

   4. Personal data reporting API - If the Personal data reporting API has the Configure button against it, then click on Configure, otherwise if it says Add, then leave it as is.

      1. Once you click on Configure, you will see a page like this:

          

      2. We need to make sure that there are no scopes enabled here. Click on Edit Scopes, deselect all scopes and Save.

          

      3. Double check that all scopes are removed.

          

5. Once all steps under #4 are correctly done, the Permissions page should have no warnings. Note that the Action may be Add for User identity API, Confluence API, and Personal data reporting API.

    

6. Next, go back to Zilla and disable the Jira integration and enable it again and click Sync Now. You should see a consent screen like this wherein you will need to click Accept to grant access to Zilla. Once you do, your Jira integration sync should complete successfully.