Add a JSM connector

Connect Harness to Jira Service Management as a Harness JSM connector.

Use a Harness JSM connector to connect Harness to Jira Service Management (JSM). This connector allows you to create and update JSM tickets, and to use JSM tickets in Approval steps.

Jira Service Management and Jira Software are separate Atlassian products. Jira Software tracks software and project work such as issues, bugs, stories, epics, and sprints. JSM is built for IT service management, covering service requests, incidents, problems, changes, and customer support portals. JSM is built on the Jira platform, so its connection settings resemble the Jira connector, but Harness treats JSM as a distinct connector type. To connect Harness to Jira Software instead, go to Add a Jira connector.

---

What you will learn from this topic

• The prerequisites for creating a JSM connector.

• Understand the limitations of the JSM connector.

• How to add a JSM connector using a username and API token, or a Personal Access Token.

• How to find YAML examples for each JSM connector authentication type.

---

Before you begin

• You can add a JSM connector at the Project, Organization, or Account scope.

• You need permission to create and edit connectors. For details, go to Configure RBAC.

• If Harness connects to JSM through a Harness Delegate, install and register a delegate before you configure the connector. For details, go to Delegate overview.

• The delegate you select for this connector must have network connectivity to the JSM API. If your JSM instance uses HTTPS with a certificate signed by a custom Certificate Authority (CA), add that CA certificate to the delegate.

• In Jira Service Management Base URL, use the base URL your users use to access JSM, for example https://your-domain.atlassian.net.

---

Limitations

Review the following limitations before you add a JSM connector.

• Your JSM account must have permissions to create and edit tickets in the relevant JSM service desks.

• When you set up the JSM connector, Username requires the full email address you use to log into JSM.

Add a JSM connector

You can add a JSM connector at the Project, Organization, or Account level. This topic covers the Project level. The process is the same for Organization and Account.

You can also add the JSM connector when setting up the JSM Create, JSM Approval, or JSM Update steps. This topic covers adding it to the Project's Connectors page.

To add a JSM connector to your Harness project:

Overview

Perform the following steps to name the connector:

1. In Project Setup, click Connectors.

2. Click New Connector, and then click JSM. The Jira Service Management connector settings appear.

3. In Name, enter a name for this connection. You will use this name to select this connection in JSM steps.

4. Click Continue.

Details

Perform the following steps to configure the JSM base URL and authentication:

1. In Jira Service Management Base URL, enter the base URL by which your users access your JSM applications. For example: https://mycompany.atlassian.net.

2. In Authentication, select one of the following:

   • Username and API Token: Enter your credentials in the Username and API Token fields.

     • In Username, enter the full email address you use to log into JSM.

     • In API Token, create or select a Harness secret that contains your JSM API token. For a YAML example of this credential type, go to Connector YAML examples.

   • Personal Access Token: In Personal Access Token, create or select a Harness secret that contains your JSM Personal Access Token (PAT). For a YAML example of this credential type, go to Connector YAML examples.

3. Click Continue.

JSM only supports Personal Access Tokens in its Server version.

Delegates Setup

Perform the following steps to select the Harness Delegates for this connector:

1. Select the Harness Delegates to use when making a connection to JSM using this connector.

2. Click Save and Continue.

Connection Test

Harness tests the connection.

Click Finish. The JSM connector is listed in Connectors.

Connector YAML examples

Use the following YAML examples to configure a JSM connector for each authentication type.

Username and API token

YAML example: Username and API token

connector:
  name: jsmApiToken
  identifier: jsmApiToken
  description: "" # optional description for the connector
  accountIdentifier: YOUR_ACCOUNT_IDENTIFIER
  orgIdentifier: default # replace with your organization identifier
  projectIdentifier: YOUR_PROJECT_IDENTIFIER
  type: Jsm
  spec:
    baseUrl: https://mycompany.atlassian.net/ # your Jira Service Management base URL
    auth:
      type: UsernamePassword
      spec:
        username: YOUR_EMAIL_ADDRESS_FOR_JSM_LOGIN # full email address used to log into JSM
        apiTokenRef: YOUR_TEXT_SECRET_CONTAINING_API_TOKEN # reference to a Harness secret holding the JSM API token
    ignoreTestConnection: false

Personal Access Token

YAML example: Personal Access Token

connector:
  name: jsmPat
  identifier: jsmPat
  description: ""
  orgIdentifier: default
  projectIdentifier: myproject
  type: Jsm
  spec:
    baseUrl: https://jsm.dev.example.io/ # Replace with your JSM Server URL
    delegateSelectors:
      - YOUR_DELEGATE_SELECTOR
    auth:
      type: PersonalAccessToken
      spec:
        patRef: YOUR_TEXT_SECRET_CONTAINING_PAT

---

Next steps

• Ticketing systems overview: Learn about the ticketing system connectors Harness supports.

• Add a Jira connector: Connect Harness to Jira Software for issue and project tracking.