Jira On Prem Authenticate an Element Instance

You can authenticate with Jira to create your own instance of the Jira On Prem element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionalities offered by the platform.

Authenticate Through the UI

Use the UI to authenticate with Jira and create an element instance as described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you will need your Username, Password, and Server URL that you identified in the API Provider Setup.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

Construct a JSON body as shown below (see Parameters):

{
  "element": {
    "key": "jiraonprem"
  },
  "configuration": {
    "username": "<JIRA_USERNAME>",
    "password": "<JIRA_PASSWORD>",
    "siteAddress": "<JIRA_LOGIN_URL>"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```
Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "jiraonprem"
  },
  "configuration": {
    "username": "xxxxxxxxxxxxxxxxxx",
    "password": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "siteAddress": "https://claudetemp.atlassian.net"
  },
  "tags": [
    "Docs"
  ],
  "name": "API TEST Instance"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.

Parameter	Description	Data Type
`key`	The element key. jiraonprem	string
Name `name`	The name of the element instance created during authentication.	string
Username `username`	The JIRA Username.	string
Password `password`	The JIRA Password.	string
Server URL `siteAdrress`	The JIRA login URL.	string
tags	Optional. User-defined tags to further identify the instance.	string

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
    "id": 123,
    "name": "Jira On Prem",
    "hookName": "JiraOnPrem",
    "key": "jiraonprem",
    "description": "Add a JIRA On Prem Instance to connect your existing Jira account to the Helpdesk Hub, allowing you to manage your incidents, priorities, statuses, users, etc. across multiple Help Desk elements. You will need your account information to add an instance.",
    "image": "elements/provider_jira.png",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "configDescription": "If you do not have a Jira.com account, you can create one at <a href=\"http://www.jira.com\" target=\"_blank\">Jira On Prem Signup</a>",
    "signupURL": "https://claudetemp.atlassian.net",
    "defaultTransformations": [  ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": false,
    "extendable": true,
    "beta": false,
    "authentication": {
        "type": "basic"
    },
    "extended": false,
    "hub": "helpdesk",
    "protocolType": "rest",
    "parameters": [],
    "private": false
    },
    "elementId": 123,
    "tags": [
      "Docs"
      ],
    "provisionInteractions": [  ],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}