Skip to content

Added workaround for Unscoped API Tokens retirement (Jira) | CDS-114228 | #11606

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added workaround for Unscoped API Tokens retirement (Jira) | CDS-114228 | #11606

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3d266a
Added work-around for Unscoped API Tokens retirement (Jira).
siddhantdua Sep 17, 2025
1d0c4c8
added harness secret details
siddhantdua Sep 17, 2025
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
28 changes: 27 additions & 1 deletion docs/platform/connectors/ticketing-systems/connect-to-jira.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,33 @@ To add a Jira connector to your Harness project:

6. In Authentication, you can select one of the following:
- **Username and API Key**: Enter your credentials. For username, use the **full email address** you use to log into Jira.
For **API Key**, use a Harness [Text Secret](/docs/platform/secrets/add-use-text-secrets). Go to [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) from Atlassian.
To obtain your **API Key**: You need to create a scoped API token in Jira with the following scopes:
- `read:jira-user` - Allows Harness to read user information
- `read:jira-work` - Allows Harness to read Jira issues and related data
- `write:jira-work` - Allows Harness to create and update Jira issues

To learn how to create a scoped API token, check out [Scoped API Tokens in Confluence Cloud](https://support.atlassian.com/confluence/kb/scoped-api-tokens-in-confluence-cloud/). Once you create the scoped API token, add it as a [Harness Text Secret](/docs/platform/secrets/add-use-text-secrets).

```yaml
connector:
name: scopedJiraApiToken
identifier: scopedJiraApiTokenID
description: "scoped API token-based Harness connector for Jira"
accountIdentifier: YOUR_ACCOUNT_IDENTIFIER
orgIdentifier: YOUR_ORG_IDENTIFIER
projectIdentifier: YOUR_PROJECT_IDENTIFIER
type: Jira
spec:
jiraUrl: https://api.atlassian.com/ex/jira/{cloud_id} # Replace {cloud_id} with your actual Cloud ID from Jira
auth:
type: UsernamePassword
spec:
username: YOUR_EMAIL_ADDRESS_FOR_JIRA_LOGIN
passwordRef: YOUR_TEXT_SECRET_CONTAINING_SCOPED_API_TOKEN
ignoreTestConnection: false
```
To ensure you have the correct Cloud ID, please refer to [Atlassian's detailed guide on finding your Cloud ID](https://support.atlassian.com/jira/kb/retrieve-my-atlassian-sites-cloud-id/).

- **Personal Access Token**: Add your Personal Access Token (PAT) to Harness as an [encrypted text](/docs/platform/secrets/add-use-text-secrets) and select the same in the Jira connector.

:::important
Expand Down