Jira
Jira is a platform for a software team to track and manage their work. You can bring the issues created in Jira into Brinqa to construct a unified view of your attack surface and strengthen your cybersecurity posture. You can also push the remediation tickets created in Brinqa Platform to Jira.
This document details the information you must provide for the connector to authenticate with Jira and how to obtain that information from Jira. See create a data integration for step-by-step instructions on setting up the integration.
Required connection settings
Jira Software can be hosted in the cloud or in a data center. If your company uses Jira Data Center, select Jira from the Connector drop-down when setting up a data integration. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate Jira with Brinqa:
-
Server URL: Your organization's Jira server URL. The default URL format is
https://<servername>/. -
Access token: The personal access token for your Atlassian account, which must have permissions to
query,create, anddeleteissues in Jira.
Create an access token for your Atlassian account
For the Jira connector to use the Jira REST API, you must provide an access token. Atlassian does not allow retrieval of an active token, therefore, you must generate a new one instead. To do so, follow these steps:
-
Log in to your Atlassian account.
-
You can obtain your personal access token in Confluence or Jira:
-
Confluence: Click your profile photo, click Settings, and then click Personal Access Tokens.
-
Jira: Click your profile photo, click Profile, and then click Personal Access Tokens.
-
-
Click Create token.
-
Enter a name, set an optional expiry date for the token, and then click Create.
Your access token displays. You cannot view the token again after this. Copy and save it to a secure location.
If you do not have permissions to create an access token, contact your Atlassian administrator. For additional information on managing personal access tokens for your Atlassian account, see the Atlassian documentation.
Additional settings
The Jira connector contains additional options for specific configuration:
-
Project key: The 3- or 4-letter abbreviation of your project name. You can specify multiple projects separated by commas, or you can leave this field blank to bring in all Jira projects.
-
Default issue type: The issue type to use when creating new issues in Jira. The default setting is Bug.
-
Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.
-
Parallel requests: The maximum number of parallel API requests. The default setting is 4.
-
Supports issue linking: Select this option to allow for linking between issues. This option is not selected by default.
-
Convert field values from html to wiki markup: Select this option to convert formatted fields from Jira to wiki markup so that they can be displayed in Confluence. This option is selected by default.
-
Skip certificate verification: Select this option to allow for untrusted certificates.
Types of data to retrieve
The Jira connector can retrieve the following types of data from the Jira REST API:
Table 1: Data retrieved from Jira
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Issue | Yes | Ticket |
For detailed steps on how to view the data retrieved from Jira in the Brinqa Platform, see How to view your data.
Operation options
The Jira connector supports the following operation options. See connector operation options for information about how to apply them.
Table 2: Jira connector operation options
| Connector Object | Option | All Possible Values | Description | Example |
|---|---|---|---|---|
| Issue | issueType | Jira issue types such as Bug, Improvement, or Task | A comma-separated list of Jira issue types. | Key: issueType, Value: Task. This key and value combination only retrieves from Jira all issues of the Task issue type. |
| project | Jira project IDs or project keys | A comma-separated list of Jira project IDs or project keys. | Key: issueType, Value: DEV,OPS. This key and value combination retrieves from Jira all issues from the DEV and OPS projects. | |
| query | A JQL query | A query written in the Jira Query Language (JQL). For additional information on JQL, see Atlassian documentation. | Key: query, Value: reporter = jdoe AND project = DEV. This key and value combination retrieves from Jira all issues reported by 'jdoe' in the 'DEV' project. |
The option keys and values are case-sensitive as they are shown in this documentation.
APIs
The Jira connector uses the Jira REST API v2. Specifically, it uses the following endpoints:
-
GET /rest/api/2/field -
POST /rest/api/2/issue -
GET /rest/api/2/issue/createmeta -
DELETE /rest/api/2/issue/{issueIdOrKey} -
PUT /rest/api/2/issue/{issueIdOrKey} -
POST /rest/api/2/issue/{issueIdOrKey}/transitions -
PUT /rest/api/2/issue/{issueIdOrKey}/transitions -
GET /rest/api/2/issue/{issueIdOrKey}/editmeta -
POST /rest/api/2/issueLink -
GET /rest/api/2/issueLinkType -
GET /rest/api/2/search
Changelog
The Jira connector has undergone the following changes:
Table 3: Jira connector changelog
This connector is part of a bundled release with other connectors from the same vendor. If a version shows "No change", it means that the connector version was updated for consistency as part of the bundle, but no functional changes were made to this specific connector. You can update to or skip this version without affecting your existing configuration.
| Version | Description | Date Published |
|---|---|---|
| 3.1.19 | Fixed an issue where the Issue object sync was failing due to a deserialization error. The connector now properly handles custom fields where the value is returned as a JSON object instead of a string. | March 22nd, 2025 |
| 3.1.18 | Fixed an issue where pushing data to version fields, such as 'Affected version' or 'Fixed version,' from Brinqa to Jira resulted in errors. The connector now properly handles multi-valued fields for versions. | November 18th, 2024 |
| 3.1.17 | Fixed an issue where the status category for issues was not being retrieved by the connector. As a result, the ISSUE_STATUS_CATEGORY attribute was added to the Issue object. | October 28th, 2024 |
| 3.1.16 | Code clean up and general maintenance. | October 17th, 2024 |
| 3.1.15 | Fixed an issue where only a limited schema was displayed in Brinqa when no project key was defined in the integration configuration, even though the full schema was visible in the Brinqa Agent logs. | September 25th, 2024 |
| 3.1.14 | A personal access token is now required for authentication. For additional information, see Create an access token for your Atlassian account. | July 2nd, 2024 |
| 3.1.13 | No change. | May 27th, 2024 |
| 3.1.12 | No change. | May 20th, 2024 |
| 3.1.11 | Improved parent-child relationships in Jira projects by enhancing the linking of Issues to Epics. | May 10th, 2024 |
| 3.1.10 | Fixed an issue where the connector was timing out when retrieving the schema. | April 8th, 2024 |
| 3.1.9 | No change. | March 28th, 2024 |
| 3.1.8 | No change. | March 13th, 2024 |
| 3.1.7 | Added more logging for troubleshooting. | December 22nd, 2023 |
| 3.1.6 | Added a date formatter for pushing Date and Date Time attributes. | December 19th, 2023 |
| 3.1.5 | - Fixed an issue where the connector was not pushing all ticket fields to Jira environments. Code clean up and general maintenance. | October 26th, 2023 |
| 3.1.4 | Enabled you to specify no project or a list of projects when connecting to a Jira server. | August 25th, 2023 |
| 3.1.3 | Code clean up and general maintenance. | August 11th, 2023 |
| 3.1.2 | Code clean up and general maintenance. | August 11th, 2023 |
| 3.1.1 | Fixed an issue where the connector sync was failing. | August 9th, 2023 |
| 3.1.0 | Added support for Jira Software version 9.x. | August 8th, 20223 |
| 3.0.3 | Enhanced to update tickets (originally created in the Brinqa Platform) when they are moved within Jira. | July 13th, 2023 |
| 3.0.2 | Fixed an issue where Test Connection failed with an error that read "Failed to access any valid project." | February 27th, 2023 |
| 3.0.1 | Added the UID attribute to the Issue object. | January 5th, 2023 |
| 3.0.0 | Initial Integration+ release. | January 3rd, 2023 |