Atlassian Jira
Source Connector
Overview
The source connector fetches data from the Jira Cloud platform REST API
Streams
| Data Source | Stream Name |
|---|---|
| audit records | audit_records |
Prerequisites
- Find the Fully Qualified Domain Name for your account. This is your Atlassian URL.
- Example: If your Atlassian URL is https://acmeco.atlassian.net, then your domain name will be
acmeco.atlassian.net
- Example: If your Atlassian URL is https://acmeco.atlassian.net, then your domain name will be
Authentication
The following authentication options are supported by this connector:
| Authentication Method | Supported | Documentation |
|---|---|---|
| API Token (Basic auth) | yes | Basic auth for REST APIs |
| Connect App | yes | Security for Connect apps |
| Forge App | no | Security for Forge apps |
| OAuth 2.0 (3LO) apps | no | OAuth 2.0 (3LO) apps |
API Token
- Create an API Token
- API Tokens are associated with an Atlassian user account. Make sure the user creating the API Token is an Atlassian Administrator.
- Obtain the email address of a user that has Jira administrator permissions
API Token Configuration Fields
| Field | Required | Description | Example |
|---|---|---|---|
| API Token | yes | API token for an Atlassian administrator | ATATT3xFfGF0pSeX2...XXXXX |
| yes | Administrator Email | [email protected] |
Connect App
- Install the Tarsal Connector for Jira app from the Atlassian Marketplace into your workspace
- The App is not yet listed on Atlassian Marketplace, therefore you will need to install it as a private app. In order to do so
- Enable Development Mode, found in the Settings link at the bottom of the page.
- Then add the app by clicking the Upload App link
- Descriptor URL:
https://api.tarsal.cloud/api/apps/atlassian/jira/connect.json
- Descriptor URL:
- The App is not yet listed on Atlassian Marketplace, therefore you will need to install it as a private app. In order to do so
- Add Permissions to user who installed the App
- Permissions required: Administer Jira global permission.
- Connect app minimum required scope:
READ
- Connect app minimum required scope:
- Permissions required: Administer Jira global permission.
- Get the security credentials for the App
- Navigate to Apps > Tarsal Connector for Jira Credentials. Copy the Shared Secret for use in the Tarsal configuration below.
Connect App Configuration Fields
| Field | Required | Description | Example |
|---|---|---|---|
| Shared Secret | yes | Connect App Shared Secret | ATCOya5J9f...AEE6329D2 |
Configuration
| Field | Required | Description | Example |
|---|---|---|---|
| Domain Name | yes | Domain name for Atlassian account | acmeco.atlassian.net |
Connector Limitations
- This connector is restricted by rate limits.
Updated over 1 year ago
Did this page help you?