-
Notifications
You must be signed in to change notification settings - Fork 455
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
134 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Jira Basic Auth | ||
sidebarTitle: Jira Basic Auth | ||
provider: jira-basic | ||
--- | ||
|
||
import Overview from "/snippets/overview.mdx"; | ||
import PreBuiltTooling from "/snippets/generated/jira-basic/PreBuiltTooling.mdx"; | ||
import PreBuiltUseCases from "/snippets/generated/jira-basic/PreBuiltUseCases.mdx" | ||
|
||
<Overview /> | ||
<PreBuiltTooling /> | ||
<PreBuiltUseCases /> | ||
|
||
## Access requirements | ||
| Pre-Requisites | Status | Comment| | ||
| - | - | - | | ||
| Paid dev account | ❓ | | | ||
| Paid test account | ❓ | | | ||
| Partnership | ❓ | | | ||
| App review | ❓ | | | ||
| Security audit | ❓ | | | ||
|
||
|
||
## Setup guide | ||
|
||
_No setup guide yet._ | ||
|
||
<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip> | ||
|
||
<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-basic.mdx)</Note> | ||
|
||
|
||
## Useful links | ||
|
||
- [Registering an App](https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/#enabling-oauth-2-0--3lo-) | ||
- [OAuth-related docs](https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps) | ||
- [List of OAuth scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/#classic-scopes) | ||
- [API v3 docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#about) | ||
- [OAuth app list (developer console)](https://developer.atlassian.com/console/myapps/) | ||
- [API rate limits](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/) | ||
- [Basic Auth-related docs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) | ||
|
||
<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-basic.mdx)</Note> | ||
|
||
## API gotchas | ||
|
||
- Refreshing tokens require the `offline_access` scope when creating the integration on the Nango UI. | ||
- You will need to fetch your Cloud ID to be able to make API requests to the Jira API v3. You can do this with the proxy by calling: | ||
|
||
```ts | ||
const response = await nango.get({ | ||
endpoint: `oauth/token/accessible-resources`, | ||
baseUrlOverride: 'https://api.atlassian.com' | ||
}); | ||
const cloudId = response.data[0].id; | ||
``` | ||
|
||
You can then construct your URL as follows: `https://api.atlassian.com/ex/jira/${cloudId}/rest/api/3/<endpoint>` | ||
|
||
- When you create an OAuth 2.0 (3LO) app, it's private by default. Before using the integration, you must make your app public. If you want to make your app public, find the how-to [here](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#distributing-your-oauth-2-0--3lo--apps). | ||
- 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](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#how-do-i-get-a-new-access-token--if-my-access-token-expires-or-is-revoked-). | ||
- Nango also supports `BASIC` auth for REST APIs in Jira. To use this feature, provide your `email` as the username and your `api_token` as the password. To generate an `api_token`, please refer to the [Manage Atlassian API Tokens](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) section | ||
- You will also need to supply your `subdomain`. When logged into your Atlassian account or Jira instance, look at the URL in your web browser. The `subdomain` part before `.atlassian.net` is your Jira subdomain. | ||
|
||
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/jira-basic.mdx)</Note> | ||
|
||
<Card title="Connect to jira-basic" icon="link" href="/integrations/all/jira-basic/connect" horizontal> | ||
Guide to connect to jira-basic using Nango Connect. | ||
</Card> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## Pre-built tooling | ||
<AccordionGroup> | ||
<Accordion title="✅ Authorization"> | ||
| Tools | Status | | ||
| - | - | | ||
| Pre-built authorization (Basic) | ✅ | | ||
| Pre-built authorization UI | ✅ | | ||
| Custom authorization UI | ✅ | | ||
| End-user authorization guide | ✅ | | ||
| Expired credentials detection | ✅ | | ||
</Accordion> | ||
<Accordion title="✅ Read & write data"> | ||
| Tools | Status | | ||
| - | - | | ||
| Pre-built integrations | ✅ | | ||
| API unification | ✅ | | ||
| 2-way sync | ✅ | | ||
| Webhooks from Nango on data modifications | ✅ | | ||
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) | | ||
| Proxy requests | ✅ | | ||
</Accordion> | ||
<Accordion title="✅ Observability & data quality"> | ||
| Tools | Status | | ||
| - | - | | ||
| HTTP request logging | ✅ | | ||
| End-to-type type safety | ✅ | | ||
| Data runtime validation | ✅ | | ||
| OpenTelemetry export | ✅ | | ||
| Slack alerts on errors | ✅ | | ||
| Integration status API | ✅ | | ||
</Accordion> | ||
<Accordion title="✅ Customization"> | ||
| Tools | Status | | ||
| - | - | | ||
| Create or customize use-cases | ✅ | | ||
| Pre-configured pagination | 🚫 (time to contribute: <48h) | | ||
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) | | ||
| Per-customer configurations | ✅ | | ||
</Accordion> | ||
</AccordionGroup> |
24 changes: 24 additions & 0 deletions
24
docs-v2/snippets/generated/jira-basic/PreBuiltUseCases.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
|
||
## Pre-built integrations | ||
|
||
<AccordionGroup> | ||
|
||
|
||
<Accordion title="Teams"> | ||
| Endpoint | Description | Readme | | ||
| - | - | - | | ||
| `GET /teams-list` | Fetch teams in an organisation in Jira | [🔗](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira-basic/actions/fetch-teams.md) | | ||
</Accordion> | ||
|
||
|
||
<Accordion title="Users"> | ||
| Endpoint | Description | Readme | | ||
| - | - | - | | ||
| `POST /users` | Creates a user in Jira. Note that this endpoint is marked as experimental and could <br />be deprecated in the future. Products are optional and allowed params are<br />jira-core, jira-servicedesk, jira-product-discovery, jira-software. Defaults to <br />jira-software. Note that the last name isn't able to be set via the API and <br />the first name defaults to the email address. | [🔗](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira-basic/actions/create-user.md) | | ||
| `DELETE /users` | Deletes a user in Jira. Note that this endpoint is marked as experimental and could <br />be deprecated in the future. | [🔗](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira-basic/actions/delete-user.md) | | ||
| `GET /users` | Fetches a list of users from Jira | [🔗](https://github.com/NangoHQ/integration-templates/blob/main/integrations/jira-basic/syncs/users.md) | | ||
</Accordion> | ||
|
||
</AccordionGroup> | ||
|
||
<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.</Tip> |