Documentation Index
Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
🚀 Quickstart
🧑💻 OAuth app setup
🔗 Useful links
🚨 API gotchas
Create an integration
In Nango (free signup), go to Integrations -> Configure New Integration -> Atlassian. Nango doesn’t provide a test OAuth app for Atlassian yet. You’ll need to set up your own by following these instructions. After that, make sure to add the OAuth client ID, secret, and scopes in the integration settings in Nango. Authorize Atlassian
Go to Connections -> Add Test Connection -> Authorize, then log in to Atlassian. Later, you’ll let your users do the same directly from your app. Call the Atlassian API
Let’s make your first request to the Atlassian API (fetch accessible resources). Replace the placeholders below with your secret key, integration ID, and connection ID:curl "https://api.nango.dev/proxy/oauth/token/accessible-resources" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
Install Nango’s backend SDK with npm i @nangohq/node. Then run:import { Nango } from '@nangohq/node';
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
const res = await nango.get({
endpoint: '/oauth/token/accessible-resources',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});
console.log(JSON.stringify(res.data, null, 2));
Create an Atlassian developer account
Create a new OAuth 2.0 (3LO) app
- Go to the Atlassian Developer Console.
- Click Create and select OAuth 2.0 integration.
- Enter a name, agree to Atlassian’s developer terms by checking the agreement checkbox for your app and click Create.
- Your app will be created and you’ll be taken to the app management page.
Configure OAuth 2.0 (3LO)
- In the left sidebar, select Authorization.
- Next to OAuth 2.0 (3LO), click Add.
- Enter
https://api.nango.dev/oauth/callback as the Callback URL.
- Click Save Changes to save your changes.
Add API permissions
- In the left sidebar, select Permissions.
- Find the APIs you want to use (Jira, Confluence, etc.) and click Add, then click Configure.
- Click Edit Scopes then select the scopes your application requires. For reference, see our Common Scopes table below.
- Click Save Changes to save your changes.
Obtain your client credentials
- In the left sidebar, select Settings.
- Copy both the Client ID and Secret by clicking the copy buttons next to them, as you’ll need them when configuring your integration in Nango.
Make your app available to users
- In the left sidebar, select Distribution.
- In Distribution controls, click the Edit button, select the Sharing radio button, enter a Privacy Policy URL and then click the Save changes button.
By default, your app is private and can only be used by you. Making it public allows other users to authorize your app.
Common Scopes
| Scope | Description |
|---|
read:jira-user | Read user information |
read:jira-work | Read Jira work items (issues, projects, etc.) |
write:jira-work | Create and update Jira work items |
delete:jira-work | Delete issues |
manage:jira-project | Manage project settings |
manage:jira-configuration | Manage Jira instance settings |
read:confluence-content.summary | Read Confluence content summaries |
read:confluence-content.all | Read all Confluence content |
write:confluence-content | Create and update Confluence content |
offline_access | Access to refresh tokens for offline access |
- Refresh tokens will expire after 365 days of non use and will expire by 90 days if the resource owner is inactive for 90 days. Make sure you call
nango.getConnection() at least every 365 days to trigger a refresh. See reference here.
- When using the proxy for Atlassian, it is important to know that Jira apps will use
/jira/{cloudid}/{api} for Jira apps and /confluence/{cloudid}/{api} for Confluence apps.
