Skip to content

doc: Section explaining Jira OAuth app permissions [CF-2052] #2514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

doc: Section explaining Jira OAuth app permissions [CF-2052] #2514

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/organizations/integrations/jira-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,43 @@

Integrate Jira with Codacy to be able to create Jira tickets directly from Codacy findings, and import your Jira issues for [Security and risk management](../managing-security-and-risk.md) to manage them all in one place as security items.

## What permissions does Codacy need from my account?

Codacy requests only the necessary [permissions/scopes from your Atlassian account](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) to collect and create issues in your Jira instance and [keeps your information secure](https://security.codacy.com/). See below the detailed list of permissions.

<table>
<colgroup>
<col width="25%"/>
<col width="75%"/>
</colgroup>
<thead>
<tr>
<th>Classic scope</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>read:jira-user</code></td>
<td>Codacy retrieves the Atlassian account ID and email of the user installing the integration.</td>
</tr>
<tr>
<td><code>read:jira-work</code> and <code>write:jira-work</code></td>
<td>
Codacy retrieves issue details and metadata, and project details, to enable:
<ul>
<li>Creating Codacy security findings from Jira issues.</li>
<li>Creating and managing issues in Jira from Codacy.</li>
</ul>
</td>
</tr>
<tr>
<td><code>manage:jira-webhook</code></td>
<td>Codacy creates webhooks to be notified of changes in the issues it's managing.</td>
</tr>
</tbody>
</table>

## Installing the Jira integration

To install the Jira integration:
Expand Down
Loading