Jira
Jira is a software that combines issue collection and agile project management capabilities into a single application. It helps to plan and organize tasks, workflows, and reports for users' agile teams more efficiently.
- 1 Authorization
- 1.1 Basic Auth
- 1.2 OAuth 2.0
- 2 Jira Connections
- 3 Actions
- 3.1 Create Issue
- 3.2 Get issues by JQL
- 3.3 Get users
- 3.4 Get user by Id
- 3.5 Create user
- 3.6 Get Issues
- 3.7 Update Issue
Authorization
Basic Auth
If the user selects Basic Auth, they will need to supply their Jira email and an API token to the credential. For information on generating an API, token refers to the Atlassian docs
OAuth 2.0
While Jira's Cloud API supports legacy OAuth1.0, Sapper only supports OAuth 2.0 flows. If the user selects OAuth 2.0, they need to enable it for their app using the developer console. For more information, follow the guide here; When a user creates their Jira app, they must be sure to enter Sapper's OAuth callback URL -Sapper - as a Callback URL. Consult Jira to determine the proper OAuth Scopes to assign to the credential. It is important to note the difference in the host URL when using OAuth 2.0. If the user is using OAuth 2.0, they MUST format their URL like the following: https://api.atlassian.com/ex/jira/{cloudId}/rest/api/2/project.
The User can obtain a cloud id by sending an authenticated request to the following endpoint: https://api.atlassian.com/oauth/token/accessible-resources Now, the user will have to configure OAuth 2.0 settings in
Sapper. The user should create a new credential of type OAuth 2.0 - Authorization Code.
For Client ID and Client Secret, enter the values that the user got from the Developer Console
For Scopes, choose from the list found on the Atlassian Docs
Jira Connections
Jira Basic Connection
Input | Key | Description | Example |
Select Application | application | Select Jira application |
|
Connection Mode | Mode | Mention the mode of connection | Custom |
Connection type | connection type | Select the type of connection. |
|
Rest Connection Type | Rest Connection Type | Select the Basic connection type |
|
Connection Name | name | Provide a name for the connection. |
|
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Jira account. | |
Username | username | Provide a valid username for the given jira account user want to connect. | exampleUser |
Password | password | Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. | exampleSecurePassword |
Header Field | header | Provide the path of the endpoint for authentication. |
|
Header Prefix | header prefix | Select the header prefix - |
|
Jira OAuth 2.0 Connection
Input | Key | Description | Example |
Select Application | application | Select Jira application |
|
Connection Mode | Mode | Mention the mode of connection | Custom |
Connection type | connection type | Select the type of connection. |
|
REST Connection Type | rest connection type | Select the type of REST connection. | OAuth 2.0 |
Connection Name | name | Provide a name for the connection. |
|
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Jira account. | |
Grant Type | grant type | Provide the grant type - Authorization code, Password, Client Credentials. |
|
Actions
Create Issue
Create an issue within a given project | key: createIssue
Input | Key | Description | Example |
Project Key | project key | Provide the project key | 10000 |
Summary | summary | Provide a string value for the summary of the issue. | Main order flow broken |
Description | description | Provide the description for the issue. |
|
Issue Type | issue type | Provide a string value for the type issue user would like to create | 10000 |
Priority Name | priority | Provide the priority order of the project. | Sample |
Get issues by JQL
Get information and metadata about an issue by id | key: findIssue
Input | Key | Description | Example |
JQL Expression | expression | Provide the JQL expression |
|
Get users
Get information and metadata about all users | getusers
Get user by Id
Get information and metadata about a user by id | key: getuser
Input | Key | Notes | Example |
Account Id | accountId | Provide a string value for the unique Id of the account | 10000 |
Create user
Create user within the given project | key: createuser
Input | Key | Description | Example |
Email Address | email address | Provide the email address of the account. | sample@gmail.com |
Display Name |
| Provide the display name of the account. | Sample |
Name |
| Provide the name of the account | Sample |
Get Issues
Get all issues about all the users | key: getIssues
Input | Key | Description | Example |
JQL |
| Provide the JQL expression |
|
startAt |
| The additional item used as the first item in the page of Jira results | 1 |
Max Results |
| maximum Results of issue you can fetch from Jira using API is set to 1000. So that is the maximum limit | 50 |
Update Issue
Update issues about all the users | key: Updateissue
Input | Key | Description | Example |
Issue id | IssueID | Provide a string value for the unique Id of the issue. | NMP-7 |
Summary | summary | Provide a string value for the summary of the issue. | This is an example summary. |