Jira Server (Data Center)

The Jira Server (Data Center) connector lets you connect to Jira Software Data Center and perform insert, delete, update, and read operations.

Supported versions

This connector supports Jira Server Data Center API versions V2 and V3.

Before you begin

In your Google Cloud project, do the following tasks:

  • Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
  • Grant the roles/connectors.admin IAM role to the user configuring the connector.
  • Grant the roles/secretmanager.viewer and roles/secretmanager.secretAccessor IAM roles to the service account that you want to use for the connector.
  • Enable the following services:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    To understand how to enable services, see Enabling services. If these services or permissions have not been enabled for your project previously, you are prompted to enable them when you configure the connector.

Configure the connector

A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following:

  1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select Jira Server (Data Center) from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
    4. Optionally, enter a Description for the connection instance.
    5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
    6. Service Account: Select a service account that has the required roles.
    7. To use the connection for event subscriptions, select Enable event subscription. The following options appear:
      • Enable event subscription with entity and actions: Select this option to use the connection for both event subscription and connector operations (entities and actions).
      • Enable only event subscription: Select this option to use the connection only for event subscription. If you select this option, click Next, and then configure event subscription.
    8. Optionally, configure the Connection node settings:

      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    9. Use proxy: Select this checkbox to configure a proxy server for the connection and configure the following values:
      • Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
        • Basic: Basic HTTP authentication.
        • Digest: Digest HTTP authentication.
      • Proxy User: A user name to be used to authenticate with the proxy server.
      • Proxy Password: The Secret manager secret of the user's password.
      • Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
        • Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
        • Always: The connection is always SSL enabled.
        • Never: The connection is not SSL enabled.
        • Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
      • In the Proxy Server section, enter details of the proxy server.
        1. Click + Add destination.
        2. Select a Destination Type.
          • Host address: Specify the hostname or IP address of the destination.

            If you want to establish a private connection to your backend system, do the following:

    10. Optionally, if you want to use SSL, select Enable SSL. This displays the SSL configuration details.
      1. Select a trust store type. It can be either Public, Private, or Insecure Connection.
      2. Select the certificates as displayed based on your trust store selection.
      3. If you are using mTLS, select the key store certificates in the Key Store section.
    11. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    12. Click NEXT.
  5. In the Destinations section, enter details of the remote host (backend system) you want to connect to.
    1. Destination Type: Select a Destination Type.
      • Select Host address from the list to specify the hostname or IP address of the destination.
      • If you want to establish a private connection to your backend systems, select Endpoint attachment from the list, and then select the required endpoint attachment from the Endpoint Attachment list.

      If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

      To enter additional destinations, click +ADD DESTINATION.

    2. Click NEXT.
  6. In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the Jira Server (Data Center) connection:

      • User Password
      • API Token
      • Personal Access Token
      • OAuth 2.0 - Authorization code

      2. To understand how to configure these authentication types, see Configure authentication.

    2. Click NEXT.
  7. Review: Review your connection and authentication details.
  8. Click Create.

Event subscription details

In the Event subscription details section, provide details of the Jira Server (Data Center) account where the event subscriptions will be created.

  1. Destination Type: Select Host address.
  2. Host: Enter the registration URL of your Jira Server (Data Center) account. Event subscriptions will be created for this URL.
  3. API token: Select the Secret Manager secret containing the API token associated with the username.
  4. Secret version: Select a secret version.
  5. Enable data enrichment: Select this checkbox if you want the Jira Server (Data Center) trigger to retrieve the complete event payload from the Jira Server (Data Center) instance. See Trigger output for examples.
  6. Select Enable private connectivity for secured connectivity between your backend application and your connection. If you select this option, you must perform additional configuration steps after creating the connection. For more information, see Private connectivity for event subscription.
  7. Enter the dead-letter configuration. If you configure dead-letter, the connection writes the unprocessed events to the specified Pub/Sub topic. Enter the following details:
    1. Dead-letter project ID: The Google Cloud project ID where you have configured the dead-letter Pub/Sub topic.
    2. Dead-letter topic: The Pub/Sub topic where you want to write the details of the unprocessed event.

Configure authentication

Enter the details based on the authentication you want to use.

  • User Password
    • Username: Enter the Jira Server (Data Center) user account used to authenticate.
    • Password: Enter the password associated with the account.
  • API Token
    • Username: Enter the Jira Server (Data Center) username used to create the API token.
    • API token: Select the Secret Manager Secret containing the API token.
  • Personal Access Token
    • Personal access token: Provide the secret manager secret containing the personal access token.
    • Secret version: Select the secret version for the secret selected.
  • OAuth 2.0 - Authorization code
    • Client ID: Provide the client ID as provided by your external application.
    • Scopes: Specify the required permission scopes.
    • Client secret : Select the Secret Manager secret. You must have created the Secret Manager secret before configuring this authorization.
    • Secret version: Select the secret manager secret version for client secret.
    • Authorization URL: Provide the URL generated during client creation.

      • For the Authorization code authentication type, after creating the connection, you must perform a few additional steps for configuring authentication. For more information, see Additional steps after connection creation.

Jira Server (Data Center) configuration

Set up an Altassian account and login to Jira Cloud

For information about setting up an Altassian account and logging to Jira Cloud, see Atlassian home.

Set up a host address and authentication details

  1. Login to your Jira Cloud instance.
  2. Enter the host address which is the instance details.
  3. Enter your username which is your Atlassian account ID.
  4. Go to Settings to generate the API token.
  5. Select Atlassian account settings from personal settings.
  6. Click the Security tab, find API tokens and click Create and Manage API tokens.
  7. Click Create API token.
  8. Enter a memorable and concise label for your token from the dialog that appears, and click Create.
  9. Click Copy to clipboard, paste the token to your script, and save for further use.

Additional steps after connection creation

If you selected OAuth 2.0 - Authorization code for authentication, you must do the following additional steps after creating the connection:

  1. In the Connections page, locate the newly created connection.

    Notice that the Status for the new connector will be Authorization required.

  2. Click Authorization required.

    This shows the Edit authorization pane.

  3. Copy the Redirect URI value to your external application.
  4. Verify the authorization details.
  5. Click Authorize.

    If the authorization is successful, the connection status will be set to Active in the Connections page.

Re-authorization for authorization code

If you are using Authorization code authentication type and have made any configuration changes in your Jira Server (Data Center) application, you must re-authorize your Jira Server (Data Center) connection. To re-authorize a connection, perform the following steps:

  1. Click on the required connection in the Connections page.

    This opens the connection details page.

  2. Click Edit to edit the connection details.
  3. Verify the OAuth 2.0 - Authorization code details in the Authentication section.

    If required, make the necessary changes.

  4. Click Save. This takes you to the connection details page.
  5. Click Edit authorization in the Authentication section. This shows the Authorize pane.
  6. Click Authorize.

    If the authorization is successful, the connection status will be set to Active in the Connections page.

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the Jira Server connection.

Jira web connection type

Field name Details
Location us-east1
Connector Jira Server (Data Center)
Connector version 1
Connection Name google-cloud-jira-rest-conn
Service Account my-service-account@my-project.iam.gserviceaccount.com
Minimum number of nodes 2
Maximum number of nodes 50
Destination Type Host Address
host 192.0.2.0
Username USERNAME
API Token API_TOKEN
Secret Version 1

System limitations

The Jira Server (Data Center) connector can process a maximum of 15 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Use the Jira Server (Data Center) connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

  • To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
  • To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Entity operation examples

This section provides examples of how to perform the entity operations in this connector.

Example - List Issues

  1. In the Configure connector task dialog, click Entities.
  2. Select Issues from the Entity list.
  3. Select the LIST operation, and then click Done.
  4. Task Input section of the Connectors task, you can set the filterClause as per the customer requirement.

    5. You must use single quotes (') to enclose the value for a filter clause. You can use the filter clause to filter records based on the columns.

    You can use the filter clause to filter records based on the columns. For example, to filter records, use the following filterClause: Location='US' and region='us-east1'.

    You can also use filterClause in entities where passing only an entity ID causes error.

Example - Get Issues

  1. In the Configure connector task dialog, click Entities.
  2. Select Issues from the Entity list.
  3. Select the GET operation, and then click Done.
  4. Set the entity ID to 10000 which is the Key ID to be passed for Issues. To set the entity ID, in the Task Input section of the Connectors task, click EntityId and then enter 10000 in the Default Value field.

    The value of the entity ID should be passed directly. Such as, 10000. Here, 10000 is the unique primary key value, which is passed.

    To use the Get operation the entity must have a unique primary key else the Get operation can not be performed.

Example - Delete Issues

  1. In the Configure connector task dialog, click Entities.
  2. Select Issues from the Entity list.
  3. Select the DELETE operation, and then click Done.
  4. Set the entity ID to 10000 which is the Key to be passed.. To set the entity ID, in the Task Input section of the Connectors task, click EntityId and then enter 10000 in the Default Value field.

Example - Create IssueTypes

  1. In the Configure connector task dialog, click Entities.
  2. Select IssueTypes from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Name": "task123456",
  "Description": "New description is added."
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": "10041"
}

Example - Create Issues

  1. In the Configure connector task dialog, click Entities.
  2. Select Issues from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
    "IssueTypeName": "Subtask", 
    "ProjectName": "kanban4", 
    "Summary": "Summary Added", 
    "ParentKey": "KN-6" 
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": 10071.0
}

Example - Create Sprints

  1. In the Configure connector task dialog, click Entities.
  2. Select Sprints from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Name": "PROJ Sprint Googlecloud",
  "State": "future",
  "Goal": null,
  "OriginBoardId": 2.0,
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": 23.0
}

Example - Create Comments

  1. In the Configure connector task dialog, click Entities.
  2. Select Comments from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "IssueId": 10001.0,
  "Body": "Adding comments to above ID by editing it"
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": 10023.0,
  "IssueId": null
}

Example - Create Users

  1. In the Configure connector task dialog, click Entities.
  2. Select Users from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "GroupName": null,
  "DisplayName": "Sample",
  "EmailAddress": "sample@gmail.com",
  "Active": true,
  "TimeZone": null,
  "Locale": "en_US",
  "AccountType": "atlassian"
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "AccountId": "557058:0a04612c-746d-4d47-a909-71ba797fe228"
}

Example - Create Worklogs

  1. In the Configure connector task dialog, click Entities.
  2. Select Worklogs from the Entity list.
  3. Select the Create operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "IssueKey": "GJCT-1",
  "Started": "2023-06-10 08:08:08",
  "TimeSpent": "2000"
}

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": "41718",
  "IssueId": 10000.0
}

Example - Update IssueTypes

  1. In the Configure connector task dialog, click Entities.
  2. Select IssueTypes from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Name": "NEW_TASK",
  "Description": "New Description"
}
  5. Set the entity ID to the entity of the IssueTypes . To set the entity ID, click entityId and then enter 10038 in the Default Value field.

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "Id": "10038"
}

Example - Update Issues

  1. In the Configure connector task dialog, click Entities.
  2. Select Issues from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "AssigneeAccountId": "61d572aa7c6f9800705289a1",
  "AssigneeName": "Charlie b"
}
  5. Set the entity ID to the entity of the Issues . To set the entity ID, click entityId and then enter 10024 in the Default Value field.

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
  "AssigneeDisplayName": "Charlie b"
}

Example - Update Sprints

  1. In the Configure connector task dialog, click Entities.
  2. Select Sprints from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Name": "PROJ Sprint Googlecloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. Set the entity ID to the entity of the Sprints . To set the entity ID, click entityId and then enter 2 in the Default Value field.

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
}

Example - Update Comments

  1. In the Configure connector task dialog, click Entities.
  2. Select Comments from the Entity list.
  3. Select the Update operation, and then click Done.
  4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field: 
    {
  "Name": "PROJ Sprint Googlecloud_Updated",
  "State": "future",
  "StartDate": "2023-06-27 07:06:08",
  "EndDate": "2023-07-27 07:06:08"
}
  5. Set the entity ID to the entity of the Comments . To set the entity ID, click entityId and then enter 2 in the Default Value field.

    If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

    {
}

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next