You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add Jira Data Center integration setup guide (ext-377) (#3744)
# Jira Data Center Integration Documentation
This PR adds comprehensive documentation for the Jira Data Center
integration, including a detailed setup guide for creating and
configuring OAuth 2.0 credentials.
## Changes
- Added complete setup guide with step-by-step instructions
- Updated access requirements section
- Reformatted useful links into a table for better readability
- Added common OAuth scopes section
- Enhanced API gotchas section with important considerations
## References
- [Jira Data Center
Documentation](https://confluence.atlassian.com/enterprise/jira-data-center-documentation-668468332.html)
- [Configure an Incoming
Link](https://confluence.atlassian.com/adminjiraserver/configure-an-incoming-link-1115659067.html)
- [Jira OAuth 2.0 Provider
API](https://confluence.atlassian.com/adminjiraserver/jira-oauth-2-0-provider-api-1115659070.html)
- [OAuth 2.0 Provider System
Properties](https://confluence.atlassian.com/adminjiraserver/oauth-2-0-provider-system-properties-1115659073.html)
Link to Devin run:
https://app.devin.ai/sessions/94f14c04f0bf4a7bb75ab740686940de
Requested by: khaliq@nango.dev
<!-- Summary by @propel-code-bot -->
---
This PR replaces placeholder and outdated Jira Data Center integration
documentation with a detailed, step-by-step setup guide. It introduces
instructions for obtaining OAuth 2.0 credentials, configures proper
access requirements, streamlines useful links and scope documentation,
and enhances the overall user experience through improved formatting and
guidance.
**Key Changes:**
• Replaced placeholder setup content with a full step-by-step OAuth 2.0
integration guide using Steps/Step components
• Updated and clarified the 'Access requirements' table (now with
precise conditions and comments)
• Converted the 'Useful links' section from table to list and refreshed
external references
• Added a 'Common Scopes' section linking directly to Atlassian
documentation
• Simplified 'API gotchas' by removing direct implementation details per
review feedback
**Affected Areas:**
• docs-v2/integrations/all/jira-data-center.mdx
*This summary was automatically generated by @propel-code-bot*
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: khaliq@nango.dev <khaliq@nango.dev>
Co-authored-by: lordsarcastic <adeoti.15.jude@gmail.com>
Co-authored-by: Khaliq <khaliqgant@gmail.com>
Copy file name to clipboardExpand all lines: docs-v2/integrations/all/jira-data-center.mdx
+67-10Lines changed: 67 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -14,20 +14,74 @@ import PreBuiltUseCases from "/snippets/generated/jira-data-center/PreBuiltUseCa
14
14
## Access requirements
15
15
| Pre-Requisites | Status | Comment|
16
16
| - | - | - |
17
-
| Paid dev account |❓ ||
18
-
| Paid test account |❓ ||
19
-
| Partnership |❓||
20
-
| App review |❓ ||
21
-
| Security audit |❓||
17
+
| Paid dev account |⚠️ Conditional | Jira Data Center requires a license. You can [start a free trial](https://www.atlassian.com/software/jira/data-center/free-trial) for development.|
18
+
| Paid test account |⚠️ Conditional | Same as above.|
19
+
| Partnership |✅ Not required||
20
+
| App review |✅ Not required ||
21
+
| Security audit |✅ Not required||
22
22
23
23
24
24
## Setup guide
25
25
26
-
_No setup guide yet._
26
+
<Steps>
27
+
<Steptitle="Set up Jira Data Center">
28
+
1. Ensure you have a running Jira Data Center instance. If not, you can:
29
+
- [Start a free trial](https://www.atlassian.com/software/jira/data-center/free-trial)
30
+
- [Install Jira Data Center](https://confluence.atlassian.com/adminjiraserver/installing-jira-data-center-938846870.html)
31
+
2. Make sure you have administrator privileges on your Jira Data Center instance.
32
+
</Step>
33
+
<Steptitle="Create an incoming link">
34
+
1. Log in to your Jira Data Center instance as an administrator.
35
+
2. Navigate to **Administration** > **Applications** > **Application links**.
36
+
3. Select **Create link**.
37
+
4. Select **External application** and then choose **Incoming** as the direction.
38
+
5. Fill in the details as described in the sections below.
39
+
</Step>
40
+
<Steptitle="Provide application details">
41
+
In the application details section:
27
42
28
-
<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>
43
+
1. Enter a descriptive name for your application.
44
+
2. For the **Redirect URL**, enter `https://api.nango.dev/oauth/callback`.
45
+
46
+
Note: This is the URL where users will be redirected after authorizing your application.
47
+
</Step>
48
+
<Steptitle="Configure application permissions">
49
+
Select the appropriate permission scopes for your integration:
50
+
51
+
-**READ**: View projects and issues the user can view, including related items like dashboards, filters, attachments, or comments.
52
+
-**WRITE**: Create, update, and delete projects and issues the user can change, including related items.
53
+
-**ADMIN**: Perform most administrative functions on the entire Jira instance.
54
+
-**SYSTEM_ADMIN**: Perform all administrative functions on the entire Jira instance.
29
55
30
-
<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-data-center.mdx)</Note>
56
+
Note: Choose only the scopes your application needs. Higher-level scopes automatically include lower-level ones (e.g., WRITE includes READ).
57
+
</Step>
58
+
<Steptitle="Obtain OAuth credentials">
59
+
1. After creating the incoming link, you'll receive your OAuth credentials:
60
+
-**Client ID**: The identifier for your application
61
+
-**Client Secret**: The secret key for your application
62
+
63
+
2. Store these credentials securely as you'll need them to configure your integration in Nango.
64
+
</Step>
65
+
<Steptitle="Configure your integration in Nango">
66
+
When setting up your Jira Data Center integration in Nango:
67
+
68
+
- Use your **Client ID** and **Client Secret** from the previous step
69
+
- For the authorization URL, use: `https://[your-jira-instance]/rest/oauth2/latest/authorize`
70
+
- For the token URL, use: `https://[your-jira-instance]/rest/oauth2/latest/token`
71
+
- Replace `[your-jira-instance]` with your actual Jira Data Center instance URL
72
+
</Step>
73
+
<Steptitle="Test the OAuth flow">
74
+
1. After configuring your integration in Nango, test the OAuth flow to ensure it works correctly.
75
+
2. The authorization flow will redirect users to Jira where they can approve access to their account.
76
+
3. After approval, users will be redirected back to your application with an authorization code.
77
+
4. This code will be exchanged for access and refresh tokens.
78
+
</Step>
79
+
<Steptitle="Next">
80
+
Follow the [_Quickstart_](/getting-started/quickstart).
81
+
</Step>
82
+
</Steps>
83
+
84
+
<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>
31
85
32
86
33
87
## Useful links
@@ -39,7 +93,10 @@ _No setup guide yet._
39
93
40
94
<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-data-center.mdx)</Note>
41
95
96
+
## Common Scopes
97
+
The list of scopes supported by the Jira Data Center API can be found in the [Provider API scopes documentation](https://confluence.atlassian.com/adminjiraserver/jira-oauth-2-0-provider-api-1115659070.html#JiraOAuth2.0providerAPI-scopes)
98
+
99
+
42
100
## API gotchas
43
-
- Jira Data Center enforce HTTPS for the base URL of production environments. You can use insecure URIs and base URLs for staging or development environments by enabling the relevant [system properties](https://confluence.atlassian.com/adminjiraserver/oauth-2-0-provider-system-properties-1115659073.html)
44
101
45
-
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-data-center.mdx)</Note>
102
+
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-data-center.mdx)</Note>
0 commit comments