integration-service
latest
false
UiPath logo, featuring letters U and I in white

Integration Service User Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Dec 10, 2024

Jira authentication

Prerequisites

Depending on the authentication type you select, you need one of the following credentials:

  • OAuth 2.0 Authorization code: Site URL, Scope, and your Atlassian email and password.
  • Bring your own OAuth 2.0 app: Client ID, Client secret, Site URL, Scope.
  • Basic: Site URL, Username, API token.
OAuth 2.0 Authorization Code

Required credentials:

  • Site URL - The URL of your Jira instance. The site URL should have a format similar to the following: https://company.atlassian.net.
  • Scope - Scopes enable an app to request a level of access to an Atlassian product. Once the connection is established and the user grants authorization via the API through the Jira activity, the OAuth app gains permission to perform the specified operations on behalf of the user, subject to the user's permission settings. For the list of scopes that can be provided please visit this page

    During the creation of a connection, you have the option to either retain the displayed scopes as they are or specify a comma-separated list of scopes of your preference. This allows you to prevent the OAuth app from automatically requesting all scope permissions by default.

    For more information, visit Scopes for Apps.

After providing the information specified above, you must log in to your Atlassian account using your Email and Password.

Bring your own OAuth 2.0 app

This authentication type is similar to the OAuth 2.0 Authorization Code, the difference being that you need to provide your own Client ID and Client Secret credentials.

Follow the Jira guidelines for creating your own app: OAuth 2.0 (3LO) apps. You can create your application from the Jira developer console.

While setting up your own Oauth2.0 App make sure to provide the redirect/callback URL as: https://govcloud.uipath.us/provisioning_/callback.

Required credentials:

  • Client ID
  • Client Secret
  • Site URL - The URL of your Jira instance. The site URL should have a format similar to the following: https://company.atlassian.net.
  • Scope - Scopes enable an app to request a level of access to an Atlassian product. Once the connection is established and the user grants authorization via the API through the Jira activity, the OAuth app gains permission to perform the specified operations on behalf of the user, subject to the user's permission settings. For the list of scopes that can be provided please visit this page

    During the creation of a connection, you have the option to either retain the displayed scopes as they are or specify a comma-separated list of scopes of your preference. This allows you to prevent the OAuth app from automatically requesting all scope permissions by default.

    For more information, visit Scopes for Apps.
Basic

This authentication type requires you to generate your own API token. You can read more on how to do this in Manage API tokens for your Atlassian account.

Required credentials:
  • Site URL - The URL of your Jira instance. The site URL should have a format similar to the following: https://company.atlassian.net.
  • Username - Your Jira username.
  • API Token - The token you have generated for you Jira instance.

Add the Jira connection

To create a connection to your Jira instance, you need to perform the following steps:

  1. Select Integration Service from Automation CloudTM Public Sector.

  2. From the Connectors list, select Jira. You can also use the search bar to narrow down the connector.

  3. Select the Connect to Jira button.
  4. Select an authentication type.

  5. Enter the required credentials for your preferred authentication method and select Connect.

  6. Your connection has been added.

Scopes

The following Scopes are required for any connection and are automatically selected: read:jira-work, write:jira-work, read:jira-user, manage:jira-configuration, manage:jira-project, manage:jira-data-provider, offiline_access.

Depending on your needs, you can select other scopes from the available multiple-selection list.

Permissions

With access to your account, UiPath for Jira Cloud is able to:

  • Manage settings:
    • Take Jira administration actions (e.g. create projects and custom fields, view workflows, manage issue link types).
    • Manage development and release information for third parties in Jira.
    • Create and edit project settings and create new project-level objects (e.g. versions and components).
  • View data:
    • View user information in Jira that the user has access to, including usernames, email addresses, and avatars.
    • Read Jira project and issue data, search for issues, and objects associated with issues like attachments and worklogs.
    Update issues:
    • Create and edit issues in Jira, post comments as the user, create worklogs, and delete issues.
  • Prerequisites
  • Add the Jira connection
  • Scopes
  • Permissions

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.