Integration: Jira Cloud

To integrate DeepSource with Jira Cloud you need a Jira OAuth 2.0 application. This document outlines the configuration, permission requirements and app configuration to get started with it.

Creating the Jira Cloud app

  1. Go to https://developer.atlassian.com and log into the Developer Console.

  2. Once logged in, click on you avatar on the top right and select Developer Console.

    Jira Developer Console Home

  3. Click on Create > OAuth 2.0 integration.

  4. Give a name to the app and click on Create.

    Jira create app

  5. Navigate to the Permissions tab. Against the Jira API click on Add and then click on Configure.

    Jira app permissions

  6. In the Jira platform REST API section click on Edit Scopes and select the following scopes:

    • read:jira-work
    • read:jira-user
    • write:jira-work

    Jira app scopes

  7. Navigate to the Authorization tab. Against OAuth 2.0 (3LO) click on Add and add the following callback URL: https://<HOSTNAME>/callback/integrations/jira.

    (Replace <HOSTNAME> with your DeepSource instance's hostname, for e.g. if your <HOSTNAME> is deepsource.stark.com, then the callback URL will be https://deepsource.stark.com/callback/integrations/jira).

    Jira app authorization

  8. Navigate to the Settings tab and note down the following values:

    • Client ID
    • Secret

    Jira app settings

Configuring the Jira Cloud app in the Admin Console

After you create your Jira Cloud application, you need to configure Client ID & Secret in the Admin Console for the application to use it.

  1. Visit the Admin Console.
  2. Navigate to Application -> Config.
  3. In the Integrations section, set "Enable Integrations" to "Yes" and select the "Jira Cloud" checkbox.
  4. Fill up the values from the previous step for:
    1. Jira Integration Client ID
    2. Jira Integration Client Secret
  5. Save.

Jira configuration on Admin Console