Permissions required for GitHub for Jira

Read-only access to actions

This permission enables access to theworkflow_run webhook event, providing information including artifacts_url, check_suite_id, conclusion, head_branch, and head_sha.

Read-only access to code scanning alerts/security events

To receive Github code scanning alerts in Jira, the app needs read permissions for security events. The app will listen to code_scanning_alert webhooks and send security report details to Jira. These will appear under the "Other links" tab of the Development Panel on Jira work items.

Read-only access to deployments

To see build and deployment information in Jira, the app needs read permissions for deployments. This allows it to listen to the webhook deployment_status event which occurs when a deployment is created. Read-only deployment permissions are used for the following webhooks:

• deployment status

Read-only access to metadata

As a mandatory requirement by GitHub, all apps have read-only metadata access by default. This is to provide access to a collection of read-only endpoints with metadata for various resources. These endpoints do not provide sensitive private repository information. Read-only metadata permissions are used for the following webhook:

• repository

Read and write access to work items and pull requests

This permission powers Smart Commit actions and allows Jira URLs to unfurl in comments. Unfurling refers to the app detecting Jira work item keys in square brackets like [ABC-123] and replacing them with respective Jira work item links.

Work items: Read and write work item permissions are used for the following webhooks:

• work item comment

• work items

Pull requests: Read and write pull request permissions are used for the following webhooks:

• pull request

• pull request review.

Notes:

1. The square brackets are required, without which the pull request may appear in the Jira work item’s Development section, but the work item key won't be expanded to a link.

2. For GitHub Enterprise integration (where the user owns the GitHub app) "Write" permission is optional. When not provided, the "unfurl" logic is gently skipped.

Read and write access to content (code)

Read permissions sync development information to Jira for the following webhooks:

• commit comment

• delete

• push

• workflow run

Write permissions allow branch creation from a work item’s dev panel.

Note: for GitHub Enterprise integration (where the user owns the GitHub app) "Write" permission is optional. When not provided, the "Create Branch" feature will not function.

Read-only access to members

To determine if you have admin access to a GitHub organization.

Code scanning alert /security events

Code Scanning alert created, fixed in branch, or closed

Commit comment

A commit comment is created

Create

A Git branch or tag is created

Delete

A Git branch or tag is deleted

Deployment status

A deployment is created

Work item comment

Activity related to a work item or pull request comment

Work items

Activity related to a work item

Pull request

Activity related to pull requests

Pull request review

Activity related to pull request reviews

Push

One or more commits are pushed to a repository branch or tag

Repository

Activity related to a repository

Workflow run

When a GitHub Actions workflow run is requested or completed