Jira integration prerequisites

Supported Jira versions

The connector supports all Atlassian-supported Jira versions. See the Atlassian Support End of Life Policy for a full list of supported Jira versions. 

Jira server information

* If both Jira and Jira Align are planned to be on site behind the firewall, then a VPN access for both the Jira Align engineer and the solutions architect is required. If no VPN access is provided to the Jira Align team, there is an additional license fee.

** You must obtain a publicly trusted SSL certificate from a certificate provider and install it on the Jira Server.

Jira user and space prerequisites

1. Create a Jira user specifically for the integration process and provide the user name and password to your assigned solutions architect. The user must have the following space permissions on all Jira spaces that you plan to synchronize to Jira Align:

• Administer Jira
• Browse spaces
• Manage sprints
• Assignable user
• Assign work items
• Close work items
• Create work items
• Edit work items
• Link work items
• Modify reporter (if you consolidated the Create and Edit Jira screens)
• Resolve work items
• Schedule work items
• Transition work items
• Add comments

Additionally, the user must have the Browse Users and Groups global permission enabled in Jira.

Note: If your Jira instance includes users in languages other than English, ensure that your Jira service user's language setting is set to English (US or UK) in Jira, and do not use Jira user translations for work item type field values so that they match the default Jira work item type names (Epic, Story, etc.)

2. Ensure that each Jira space and its work items meet the following criteria:

• Both the Create Work Item and Edit Work Item screens have the Jira Story Points field editable by the Jira Align user account.
  • Note: A Story Points field must be enabled for the Epic work item type in Jira spaces you connect to if the Enable Feature Point Sync setting is set to Yes in Jira Align. This setting controls the sync of points from Jira Align features to Jira epics, and syncs will fail if a field is not found in Jira. Because Jira Align converts an entered estimate into all three available estimation systems, syncing will always send a points value to Jira when the setting is enabled.  
• When a work item's state changes, the Jira workflow is configured to only require a reason for changing the state and no other fields are required. This is needed for the proper bidirectional syncing of state for stories and features (epics in Jira).
• To ensure space-specific mappings are correct, refer to the Jira API call below. Jira Administrators, replace "mycompany.atlasssian.net" with the URL for your Jira instance and replace "CON-79" work item key with a work item key ID from the space(s) that will be integrated with Jira Align.

https://mycompany.atlassian.net/rest/api/latest/issue/CON-79/transitions?expand=transitions.fields

Jira Data Center prerequisites

If you're using Jira Data Center with your Jira connector, the Jira application setting for User email visibility must be set to PUBLIC or LOGGED IN USERS ONLY.

API URLs for Jira connector

These are the four API-based wildcard endpoints that the Jira connector requires.

/rest/auth/*

/rest/api/2/*

/rest/agile/1.0/*

/rest/greenhopper/1.0/*

The documentation for the above APIs can be found here:
https://docs.atlassian.com/jira-software/REST/server/
https://docs.atlassian.com/jira-software/REST/cloud/