Jira Cloud
IT Service Management- Overview
- Setup
- Data & mappings
- Operations & API
- Changelog
The Jira Cloud connector integrates with Atlassian Jira Cloud to synchronize project, issue, issue type, issue status, issue field, and user data into the Brinqa platform. It supports bidirectional operations including creating, updating, deleting, and transitioning Jira issues, as well as issue linking. The connector uses the Jira Cloud REST API v3 with cursor-based pagination for issue search.
Data retrieved from Jira Cloud
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Project | Yes | — |
| Issue | Yes | — |
| Issue Type | Yes | — |
| Issue Status | Yes | — |
| Issue Field | Yes | — |
| User | Yes | Person |
Model relationships
For detailed steps on how to view the data retrieved from Jira Cloud in the Brinqa Platform, see How to view your data.
Do not send displayName, emailAddress, or name as the assignee value. Jira Cloud requires the accountId, which is available as the UID attribute of the synced User object type.
If comment posting fails during creation, the error is logged but the issue is still created successfully. Comment failures do not roll back the issue creation.
Connection settings
When setting up a data integration, select Jira Cloud from the Connector dropdown and provide the following:
| Setting | Required | Default | Description |
|---|---|---|---|
| Service URL | Yes | Default - (user input, Required) | JIRA rest interface URL |
| Yes | Default - (user input, Required) | User with proper access to query, create, and delete issues. | |
| API token | Yes | Default - (user input, Required) | User API token. |
| Project key | No | Default - (user input) | Project key for the project usually a three letter abbreviation of the project name. Multiple project keys can specified as comma separated list. |
| Default issue type | No | Bug | Default issue type when creating new issues. |
| Page size | No | 100 | Maximum number of records to get per API request |
| Parallel requests | No | 1 | Maximum number of parallel API requests |
| Maximum retries | No | 5 | The maximum number of retry attempts before giving up a request |
| Request timeout (secs) | No | 120 | The maximum seconds allotted before a request will time out. Enter zero (0) to disable timeouts (not recommended). |
| Issue linking | No | false | Supports issue linking |
| Render fields | No | true | Convert field values from html to wiki markup |
Authentication
Method
Basic Authentication (Email + API Token)
Endpoint
| Method | URL |
|---|---|
| All requests | https://{your-domain}.atlassian.net/rest/api/3/* |
Usage
All API requests include Base64-encoded credentials in the Authorization header:
Authorization: Basic base64({email}:{api-token})
Accept: application/json
How to Generate an API Token
- Log in to https://id.atlassian.com/manage-profile/security/api-tokens
- Click Create API token
- Provide a label and click Create
- Copy the token value
Sync Behavior
The connector supports incremental synchronization through a sync token that carries the timestamp of the last successful sync as a since (Instant) value.
- Issue — Incremental. When a
sincevalue is present, the JQL search (GET /rest/api/3/search/jql, cursor-based pagination) is constrained withupdated > "<timestamp>", so only issues modified since the previous sync are retrieved. Without a sync token, all issues matching the configured project(s) are fetched. - Project, Issue Type, Issue Status, Issue Field, User — Full sync on every run. These metadata models are re-enumerated (per project, and per issue type where applicable); the
sincetoken is not used to filter them.
How to obtain Jira Cloud credentials
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.
Note: 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.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes:
Project
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
ProjectResource.description | DESCRIPTION |
ProjectResource.id | UID |
ProjectResource.key | PROJECT_KEY |
ProjectResource.name | NAME |
Issue
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
Issue.fields.comment | COMMENTS |
Issue.fields.created | SOURCE_CREATED_DATE |
Issue.fields.project.id | PROJECTID |
Issue.fields.project.key | PROJECT |
Issue.fields.project.name | PROJECTNAME |
Issue.fields.resolution.name | RESOLUTION |
Issue.fields.resolutiondate | RESOLUTIONDATE |
Issue.fields.status.name | STATUS |
Issue.fields.status.statusCategory.name | STATUS_CATEGORY |
Issue.fields.timetracking.remainingEstimateSeconds | REMAINING_ESTIMATE_SECONDS |
Issue.fields.timetracking.timeSpentSeconds | TIME_SPENT_SECONDS |
Issue.fields.updated | SOURCE_LAST_MODIFIED |
Issue.id | UID |
Issue.id | ISSUE_ID |
Issue.key | ISSUE_KEY |
Additional custom fields and issue link types are dynamically discovered from the Jira API during schema resolution. The full attribute set varies per Jira project and issue type configuration. The Cloud connector also includes STATUS_CATEGORY which is not present in the Server connector.
Issue Type
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
IssueTypeResource.description | DESCRIPTION |
IssueTypeResource.hierarchyLevel | HIERARCHY_LEVEL |
IssueTypeResource.id | ISSUE_TYPE_ID |
IssueTypeResource.name | NAME |
IssueTypeResource.subtask | SUBTASK |
ProjectResource.key | PROJECT_KEY |
{projectKey}-{issueType.name} | UID |
Issue Status
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
IssueTypeStatusesResource.name | ISSUE_TYPE |
| Project key | PROJECT_KEY |
StatusResource.description | DESCRIPTION |
StatusResource.id | STATUS_ID |
StatusResource.name | STATUS_VALUE |
{projectKey}-{issueType.name}-{status.name} | UID |
{projectKey}-{issueType.name}-{status.name} | NAME |
Issue Field
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
IssueFieldResource.allowedValues[].value or name | ALLOWED_VALUES |
IssueFieldResource.fieldId | FIELD_ID |
IssueFieldResource.hasDefaultValue | HAS_DEFAULT_VALUE |
IssueFieldResource.key | FIELD_KEY |
IssueFieldResource.name | NAME |
IssueFieldResource.operations | OPERATIONS |
IssueFieldResource.required | REQUIRED |
IssueFieldResource.schema.type | FIELD_TYPE |
IssueTypeResource.name | ISSUE_TYPE |
ProjectResource.key | PROJECT_KEY |
{projectKey}-{issueType.name}-{field.key} | UID |
User
| Source Field Name | SDM Attribute |
|---|---|
Instant.now() | LAST_CAPTURED |
UserResource.accountId | UID |
UserResource.accountType | ACCOUNT_TYPE |
UserResource.active | IS_ACTIVE |
UserResource.displayName | USERNAME |
UserResource.emailAddress | |
UserResource.key | KEY |
UserResource.name | NAME |
Operations & API
Expand each connector object to see its operation options, delta-sync behavior, and the API it uses. See connector operation options for how to apply operation options (keys and values are case-sensitive).
Project
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Project on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/project/search
Issue
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Issue on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/search/jql
Issue Type
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Issue Type on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/project/search
Issue Status
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Issue Status on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/project/{projectKey}/statuses
Issue Field
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Issue Field on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/issue/createmeta/{projectKey}/issuetypes/{issueTypeId}
User
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of User on every run and applies no incremental date filter.
API
- Type: REST · Endpoint:
GET /rest/api/3/users/search
Changelog
The Jira Cloud connector has undergone the following changes:
| Version | Description | Migration Steps |
|---|---|---|
| 3.2.3 | Improvements - Extracted redundant getProjectKey() / toMD5(projectKeys) logic into a reusable helper method to eliminate duplication across sync operations - Schema creation does not receive a transaction_id from operation options, so the directory structure for Project and Issue Field models is now determined based on whether a project key is present in the connector configuration | N/A |
| 3.2.2 | Improvements - Issue create and update operations now use the Jira Cloud REST API v3 issue endpoint, aligning issue writes with the v3 API used elsewhere in the connector. | N/A |
| 3.2.1 | Improvements - Refactored custom model attributes to use AttributeInfos.newAttribute() (for single-valued) or new AttributeInfoBuilder() with explicit COLLECTION_CRITERIA mappings (for multivalued attributes) to correctly inherit consolidation mappings; restricted custom attribute visibility to private - Consolidated all REST API endpoint paths into JiraCloudModel as public static final constants (e.g., PROJECT_SEARCH_ENDPOINT, ISSUE_SEARCH_ENDPOINT, USERS_SEARCH_ENDPOINT); removed hardcoded URL strings from Issue.java, IssueStatus.java, and JiraCloudConnector.java - Added addCommentsAfterCreate in Issue.java — with direct Java Map/List construction and ObjectMapper serialization, producing a minimal update.comment JSON payload - Alphabetically ordered model types in objectClassInfoTypes(), getModel(), and sync() switch cases in JiraCloudConnector.java for consistency - Added Javadoc with sample JSON response on UserResource and IssueTypeResource - Removed unused imports ( SimpleKVStore, UserResource) from Issue.java - Moved ISSUE_API_PATH constant from JiraCloudConnector to JiraCloudModel for centralized access - Added mockwebserver test dependency (4.12.0) to pom.xml for MockWebServer-based integration tests - Created JiraCloudConnectorIntegrationTests with 9 integration tests covering connection, schema, and sync for all 6 Cloud models using canned JSON responses - Added 6 mock JSON response fixtures for project search, user search, issue search, issue type statuses, and issue createmeta endpoints - Modernized JiraCloudConnectorTests: corrected testConnection method name, added @After tearDown() lifecycle method, added testBadConnection test - Corrected JiraCloudConfiguration property order numbering - Updated jira-cloud.md documentation to reflect current model attributes and connector capabilities - Renamed License.txt to LICENSE.txt for conventional uppercase naming - Added LAST_CAPTURED mandatory attribute to all six Jira Cloud models: Project, Issue Type, Issue Status, Issue Field, User, and Issue - Added comment support during Jira Cloud ticket creation — comments can now be attached as part of the initial create operation - Added Postman collection ( Jira_Cloud_Connector.postman_collection.json) and companion environment file for testing all Jira Cloud REST API endpoints | N/A |
| 3.2.0 | No changes in this release. | N/A |
| 3.1.26 | No changes in this release. | N/A |
| 3.1.25 | No changes in this release. | N/A |
| 3.1.24 | New Features - Added handling for Jira rate limiting (HTTP 429). When Jira Cloud responds with a rate-limit error, the connector now honors the Retry-After interval and automatically retries instead of failing the sync. Improvements - Authentication and permission failures now surface clearer messages (for example, "Bad credentials" on HTTP 401 and "Insufficient rights to the resource" on HTTP 403). | N/A |
| 3.1.23 | No changes in this release. | N/A |
| 3.1.22 | New Features - Added new models that are synchronized alongside issues: Project, Issue Type, Issue Status, Issue Field, and User. These provide richer context about the Jira Cloud instance being synced. | N/A |
| 3.1.21 | Bug Fixes - Fixed issue update operations that could fail by routing updates through the supported Jira Cloud issue endpoint. | N/A |
| 3.1.20 | Improvements - Jira Cloud issue retrieval and search now use the current Jira Cloud REST API, improving compatibility and reliability of issue synchronization. | N/A |
| 3.1.19 | Bug Fixes - Fixed parsing of custom fields returned in a nested object format. Affected custom field values are now read correctly instead of causing the issue to fail to sync. | N/A |
| 3.1.18 | No changes in this release. | N/A |
| 3.1.17 | New Features - Added a Status Category attribute on issues, exposing the broader category (such as To Do, In Progress, or Done) for each issue's status. | N/A |
| 3.1.16 | Bug Fixes - Corrected response log levels so that successful responses are logged at the debug level and only genuine error responses are logged as errors, reducing log noise. | N/A |
| 3.1.15 | Improvements - When no project is configured, field metadata is now derived from multiple projects (up to ten) instead of a single project, producing a more complete set of available issue fields. | N/A |
| 3.1.14 | No changes in this release. | N/A |
| 3.1.13 | No changes in this release. | N/A |
| 3.1.12 | No changes in this release. | N/A |
| 3.1.11 | New Features - Added support for setting an issue's parent, allowing issues to be linked to an epic (or other parent) when they are created or updated. | N/A |
| 3.1.10 | Improvements - When no project is configured, the connector now automatically detects available projects to retrieve issue field metadata, so field discovery works without requiring a project to be specified. | N/A |
| 3.1.9 | New Features - Added a Request Timeout setting to control how long the connector waits for a response from Jira Cloud. - Added a Max Retries setting to control how many times a failed request is retried. | N/A |
| 3.1.8 | No changes in this release. | N/A |
| 3.1.7 | Improvements - Improved error reporting for failed API responses, making connection and sync failures easier to diagnose. | N/A |
| 3.1.6 | Improvements - Improved handling of date and date-time issue fields when creating and updating issues, so date-only fields and timestamped fields are written in the correct format. | N/A |
| 3.1.5 | No changes in this release. | N/A |
| 3.1.4 | Improvements - Project settings now accept either a project ID or a project key, so connections can be configured using whichever identifier is available. | N/A |
| 3.1.3 | No changes in this release. | N/A |
| 3.1.2 | No changes in this release. | N/A |
| 3.1.1 | No changes in this release. | N/A |
| 3.1.0 | No changes in this release. | N/A |
| 3.0.4 | No changes in this release. | N/A |
| 3.0.3 | New Features - Added an Issue Key attribute so each issue's human-readable key is available in addition to its internal ID. | • Issue: Issues are now uniquely identified by their internal issue ID instead of their issue key. Action: re-sync issues so they are re-keyed under the new identifier. |
| 3.0.2 | No changes in this release. | N/A |
| 3.0.1 | Improvements - The unique identifier of each issue is now exposed as a readable attribute. | N/A |
| 3.0.0 | Overview The Jira Cloud connector integrates with Atlassian Jira Cloud to synchronize issues, including their fields, statuses, comments, and links. Category: IT Service Management Models | N/A |