1. General Information
Jira, developed by Atlassian, is a comprehensive project management platform designed for issue tracking, bug tracking, and agile project management. It enables teams to efficiently plan, monitor, and manage tasks through customizable workflows, boards, and dashboards.
2. Connect Jira Cloud Platform to OneTeg
Authentication and connection to the Jira Cloud Platform may be established utilizing either OAuth 2.0 or basic authentication methods.
A. OAuth2.0 Jira App Creation
To create an app for OAuth2.0 authentication, please start by logging in to https://developer.atlassian.com/console.
The Jira Cloud Platform permits the configuration of only a single Callback URL per connected application. Consequently, each OneTeg instance must be registered as an individual Jira App.
Adding Scopes to the Jira App
Upon creating a Jira App, proceed to the Permissions tab and select the Configure button to assign the necessary scopes to the Jira App.
Getting Client ID and Secret Values
Access the Settings page in the Jira application to obtain the Client ID and Client Secret credentials.
B. Basic Authentication
The authentication method utilized for HTTP requests is HTTP Basic. To authenticate requests via HTTP, it is necessary to generate an API Token, which functions as the password. To generate this token, select the user icon located in the top right corner of the Jira board and then choose Account settings.
Proceed to the subsequent page and select the Security tab. To generate a new token or access existing tokens, click on the Create and Manage API tokens link.
Select Create API token to generate the necessary token. Additionally, any previously issued tokens may be revoked through this interface.
Upon generation, the token is utilized as a password in conjunction with the users email address serving as the username.
Username: user.email@xyz.com
Password: Generated Token
3. Connection Settings and Configuration for OneTeg
Jira utilizes distinct hostnames for OAuth2 authentication and Basic authentication mechanisms.
Retrieving the Jira Cloud Identifier
The cloud identifier for the Jira site can be obtained by accessing the following URL while authenticated in Jira through a web browser.
Construct the request URL
Requests utilizing OAuth 2.0 authentication are directed to api.atlassian.com, whereas requests employing basic authentication utilize the URL https://your-domain.atlassian.net.
Formulate your request URL according to the following format:
-
Jira applications:
https://api.atlassian.com/ex/jira/{cloudid}/{api}
Connection Settings in OneTeg for Basic Authentication
In the Username field, enter the email address associated with the account, and in the Password field, enter the Token Value (not the login password) that has been generated.
Connection Setting for OAuth2.0
|
Settings Parameters |
Value |
Description |
Required (Y/N) |
|---|---|---|---|
|
Connector |
Jira Connector |
Preferred Connector Designation |
Y |
|
Host Name |
https://api.atlassian.com/ex/jira/{yourcloudid} |
Endpoint required for performing CRUD operations |
Y |
|
Authentication |
OAuth2 |
Type of authentication |
Y |
|
Authentication URL |
|
|
|
|
Token URL |
|
|
|
4. Supported Jira Cloud Platform Actions and Options