Skip to content

Commit 4db0fb8

Browse files
authored
Added workaround for Unscoped API Tokens retirement (Jira) | CDS-114228 | (#11606)
* Added work-around for Unscoped API Tokens retirement (Jira). * added harness secret details
1 parent ef6d386 commit 4db0fb8

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

docs/platform/connectors/ticketing-systems/connect-to-jira.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,33 @@ To add a Jira connector to your Harness project:
4141

4242
6. In Authentication, you can select one of the following:
4343
- **Username and API Key**: Enter your credentials. For username, use the **full email address** you use to log into Jira.
44-
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.
44+
To obtain your **API Key**: You need to create a scoped API token in Jira with the following scopes:
45+
- `read:jira-user` - Allows Harness to read user information
46+
- `read:jira-work` - Allows Harness to read Jira issues and related data
47+
- `write:jira-work` - Allows Harness to create and update Jira issues
48+
49+
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).
50+
51+
```yaml
52+
connector:
53+
name: scopedJiraApiToken
54+
identifier: scopedJiraApiTokenID
55+
description: "scoped API token-based Harness connector for Jira"
56+
accountIdentifier: YOUR_ACCOUNT_IDENTIFIER
57+
orgIdentifier: YOUR_ORG_IDENTIFIER
58+
projectIdentifier: YOUR_PROJECT_IDENTIFIER
59+
type: Jira
60+
spec:
61+
jiraUrl: https://api.atlassian.com/ex/jira/{cloud_id} # Replace {cloud_id} with your actual Cloud ID from Jira
62+
auth:
63+
type: UsernamePassword
64+
spec:
65+
username: YOUR_EMAIL_ADDRESS_FOR_JIRA_LOGIN
66+
passwordRef: YOUR_TEXT_SECRET_CONTAINING_SCOPED_API_TOKEN
67+
ignoreTestConnection: false
68+
```
69+
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/).
70+
4571
- **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.
4672
4773
:::important

0 commit comments

Comments
 (0)