Jira Cloud

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 Cloud 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 Cloud, select Jira Cloud 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 Cloud with Brinqa:

• Server URL: The Jira Cloud server URL.

• Email: The email address of your Atlassian account, which must have permissions to query, create, and delete issues in Jira Cloud.

• API token: The API token created for your Atlassian account.

Create an API Token for your Atlassian account

For the Jira Cloud connector to use the Jira Cloud platform REST API, you must provide an API token. Atlassian does not allow retrieval of an active token, therefore, you must generate a new token instead. To do so, follow these steps:

1. Log in to your Atlassian account.

2. Navigate to API Tokens at https://id.atlassian.com/manage-profile/security/api-tokens.

3. Click Create API token.

4. Enter a label for the token and click Create.

   A new API token displays. You cannot view the token again. Copy the API token and save it in a secure location.

5. Set the timezone for the account to UTC. This ensures accurate synchronization of data between Jira and Brinqa, as all data is stored in UTC time.

note

For additional information on managing API tokens for your Atlassian account, see the Atlassian documentation.

Additional settings

The Jira Cloud 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.

• Request timeout (secs): The maximum time allotted, in seconds, before a request times out. The default setting is 120 seconds. Although it is not recommended, you can also enter zero (0) to disable timeouts.

• Maximum retries: The maximum number of times that the integration attempts to connect to the Jira API before giving up and reporting a failure. The default setting is 5.

• 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.

Types of data to retrieve

The Jira Cloud 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

info

For detailed steps on how to view the data retrieved from Jira Cloud in the Brinqa Platform, see How to view your data.

Operation options

The Jira Cloud connector supports the following operation options. See connector operation options for information about how to apply them.

Table 2: Jira Cloud connector operation options

Connector Object	Option	All Possible values	Description	Example
Issue	issueType	Any Jira issue type. Examples include: 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.

note

The option keys and values are case-sensitive as they are shown in this documentation.

APIs

The Jira Cloud 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 Cloud connector has undergone the following changes:

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.

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.

3.1.16

• No change.

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.

3.1.14

• No change.

3.1.13

• No change.

3.1.12

• No change.

3.1.11

• Improve parent-child relationships in Jira projects by enhancing the linking of Issues to Epics.

3.1.9

• Fixed an issue where the connector was timing out when retrieving the schema.

3.1.4

• Enabled you to specify no project or a list of projects when connecting to a Jira server.

3.1.0

• Added support for Jira Software version 9.x.

3.0.0

• Initial Integration+ release.