JIRA REST Connector 25.1
JIRA REST Connector Help

# Authentication (JIRA in the Cloud)

To retrieve information from a JIRA instance that is hosted in the cloud, you can:

- Authenticate using HTTP basic authentication, using a user name and API token.
- Authenticate using OAuth.

## Configure HTTP Basic Authentication

To authenticate using HTTP basic authentication, you must obtain an API token.

To obtain an API token

1. Log in to your Atlassian account and go to the Security tab in your profile.
2. Click Create and Manage API tokens.

3. Click Create API token, and make a note of the API token.

   When you configure the connector, set the parameter `BasicUsername` to your user name and `BasicPassword` to your API token. For more information about configuring a fetch task, see Retrieve Data from JIRA.

## Configure OAuth

To authenticate using OAuth, you must create an OAuth application to represent the connector and then run the OAuth configuration tool.

To create a new OAuth application

1. Go to https://developer.atlassian.com/console/myapps/.
2. Create a new "OAuth 2.0 integration" app (click Create > OAuth 2.0 integration).

3. Type a name for the app and click Create.

   The app is created and an overview page is displayed.

4. Click the Settings tab and make a note of the client ID and secret assigned to the app.

5. Click the Permissions tab, and add the Jira platform REST API by clicking Add.

   The "Add" button is replaced by a "Configure" button.

6. Click Configure and allow (add) the following permissions:

   Permission | Required For
   --- | ---
   View Jira issue data | Connector read operations
   Create and manage issues | Connector write operations
   Manage project settings | Mapped security
   Manage Jira global settings | Mapped security

7. Click the Authorization tab, and then click Configure next to the OAuth 2.0 (3LO) option.

8. Specify a redirect (callback) URL.

   - To use the NiFi Ingest connector, the redirect URL must match the URL shown in the advanced configuration dialog of the NiFi processor. (In the NiFi web interface, right-click the processor and click Configure. Then click ADVANCED. You can find the redirect URL on the OAUTH SETUP tab).
   - To use the standard connector, the redirect URL must match the value of the `RedirectUrl` parameter in the OAuth tool configuration file, `oauth_tool.cfg`. The default value is `http://localhost:7878/`.

To configure OAuth authentication

- To configure the NiFi Ingest connector

  1. In the NiFi web interface, right-click the processor and click Configure.
  2. Click ADVANCED, and complete the guided setup wizard. Then configure OAuth using the OAUTH SETUP tab.

- To configure the standard connector

  1. Open the folder where you installed the connector.
  2. Open the file `oauth_tool.cfg` in a text editor.

  3. In the `[Default]` section, set any SSL or proxy settings that are required to access the repository:

     `SSLMethod` | The version of SSL/TLS to use.
     `ProxyHost` | The host name or IP address of the proxy server to use.
     `ProxyPort` | The port of the proxy server to use.

     For example:

         SSLMethod=NEGOTIATE
         ProxyHost=10.0.0.1
         ProxyPort=8080

  4. In the `[OAuthTool]` section, set the following parameters:

     `AppKey` | The client ID that was provided when you set up the OAuth application.
     `AppSecret` | The client secret that was provided when you set up the OAuth application.

     Do not modify the other parameters in this section.

  5. Open a command-line window and run the following command.

     `oauth_tool.exe oauth_tool.cfg OAuthTool`

     Your default web browser opens. The web page asks you to log in and grant consent for the connector to access JIRA.

  6. Log in, as a user who can view everything you want to ingest, and grant consent.

     The web page displays a message stating that the OAuth details have been successfully stored, and the OAuth tool creates the files `oauth.cfg` and `oauth2_sites.bin`. When you configure the connector, import the parameters from `oauth.cfg` into your task configuration. For more information about including parameters from another file, see Include an External Configuration File.

     For more information about configuring a fetch task, see Retrieve Data from JIRA.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery JIRA REST Connector 25.1

Topic Title: Authentication (JIRA in the Cloud)