Jira
Description
The Jira plugin enables AutomationEdge workflows to interact with Jira Server/Data Center and Jira Cloud through Jira REST APIs. It allows workflows to create, read, update, and manage Jira entities such as issues, projects, users, comments, attachments, and workflow transitions. The plugin supports configurable API versions (v2 for Server/Data Center and v3 for Cloud) and handles authentication using Jira credentials or API tokens based on the deployment type. Outputs from each step can be used for further processing or decision-making in next step.
From plugin version 4.4 and above, the JIRA step is configured to use API version 3 by default, which is supported only by JIRA Cloud. This default applies both to new workflows and to existing workflows after upgrading the plugin. If your workflow uses JIRA Server or JIRA Data Center (on-premises), you must explicitly change the API version to 2 in the step configuration. If the API version is not updated, the step will continue to use version 3 and may fail to execute for Server/Data Center instances. To ensure correct behaviour, always verify and set the appropriate API version based on your JIRA deployment type.
The current implementation of the Jira Plugin supports only Basic Authentication for accessing the Jira REST API.
As a result, Basic Authentication must be enabled on the Jira instance for the plugin to function correctly. In environments where Basic Authentication is disabled by default (such as certain Jira Server or Data Center setups), it must be manually enabled as part of the Jira configuration.
Failure to enable Basic Authentication will prevent the plugin from successfully communicating with the Jira REST API.
Common Tab Details: Connection tab
The following table explains the connection tab and its field details, which is a common configuration available across steps.
| Field Name | Description |
|---|---|
| Base URL | Specify the base URL used to connect to the JIRA instance. - On-premise (Server/Data Center): Enter the IP address, fully qualified domain name (FQDN), or hostname of the JIRA server, with the port if required (for example, hostname:port). - JIRA Cloud: Enter the JIRA instance URL (for example, https://xxxx.atlassian.net/). |
| API Version | Specify the Jira REST API version that the step uses to communicate with Jira. Set the value to 2 for Jira Server or Jira Data Center, and to 3 for Jira Cloud. The selected API version determines the supported endpoints and request format. Selecting the correct version ensures compatibility and prevents request or authentication errors. API versions are defined by Atlassian and may change over time. |
| Username | Specify a username with the required permissions to authenticate to the JIRA instance and add a comment. The field is mandatory. |
| Password | |
| Accept Value as variable/static | Select this checkbox to control how the field accepts input. When selected, the field appears as a text box and accepts a static value or an environment variable. When cleared, the field appears as a drop-down list that displays values from previous steps. |
| Password/API Key | Provide authentication credentials for the JIRA instance. - JIRA Cloud: Enter the API key. - JIRA Server/Data Center: Enter the password. You can enter the value in one of two ways. In Text mode, type a static value or use an environment variable. In Combo mode, select a value from the output of a previous step. The field is mandatory. Note: Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html |
| Test Connection | Click Test Connection to verify that the connection to the JIRA instance is successfully established. Note: Fields from previous steps cannot be used for this verification because their values are available only when the workflow is running. You can use static values or environment variables. |