The Jira activities use either OAuth 2.0 or Token Authentication to establish a connection between UiPath and your Jira environment. This connection authorizes a Robot to call the Jira APIs and access resources on your behalf.

For more information and before you build your first automation project, see the Setup guide.

You select the type of authentication that you want to use (Authentication Type) and enter the URL of your Jira server (Server URL) into the Jira Scope activity.

Then enter in either your OAuth Credentials (ClientID and ClientSecret) or your Token Credentials (Api Token and Username) to complete the information needed to establish an authenticated connection to your Jira application.

After establishing a connection, a parent Jira Scope activity can output a record of the connection in a Jira Connection object (Jira Connection) that you can use in subsequent child scope activities.

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

Complete the Setup steps.
Add the Jira Scope activity to your project.
Select your Authentication Type and enter value for either your OAuth Authentication or Token Authentication properties.
Create and enter a Jira Connection variable for Output property.
- You can use this variable in subsequent uses of the Jira Scope activity.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes	Details
Type	`String`
Required	Yes
Default value	Jira Scope
Allowed values	Enter a `String` or `String` variable.
Notes	N/A

ContinueOnError

Specifies if you want the activity to continue running when an error is thrown.

Attributes	Details
Type	`Boolean`
Required	Yes
Default value	False
Allowed values	Enter a `Boolean` value
Notes	N/A

Authentication

Authentication Type

The type of authentication that you want to use to connect to your Custom App.

Attributes	Details
Type	Drop-down list
Required	Yes
Default value	Api Token
Allowed values	Select an item from the drop-down list.
Notes	There are 3 options: Api Token - Uses an API token OAuth 2.0 - Users a ClientID and ClientSecret Jira Connection - Optional for subsequent runs of the Jira Scope activity within the same automation project that includes a parent scope.

Server Url

The URL to the Jira site where you want to perform the activities

Attributes	Details
Type	`String`
Required	Yes
Default value	Empty
Allowed values	Enter a `String` or `String` variable.
Notes	N/A

Existing Jira Connection

Jira Connection

A connection record from a parent Jira Scope activity that you can use instead of establishing a new connection.

Attributes	Details
Type	`JiraClient`
Required	Yes if Authentication Type is `Jira Connection`
Default value	Empty
Allowed values	Enter a `JiraConnection` variable.
Notes	The `JiraConnection` variable must be from a previously run Jira Scope activity (parent) that still has an active connection. If you're unable to establish a connection using this property, try re-running your parent Jira Scope activity.

OAuth Authentication

Client ID

The Client ID for your Jira application.

Attributes	Details
Type	`String`
Required	Yes if Authentication Type is `OAuth Authentication`
Default value	Empty
Allowed values	Enter a `String` or `String` variable.
Notes	N/A

Client Secret

The client secret of the Jira application

Attributes	Details
Type	`SecureString`
Required	Yes if Authentication Type is `OAuth Authentication`
Default value	Empty
Allowed values	Enter a `SecureString` or `SecureString` variable.
Notes	N/A

Token Authentication

Api Token

The token that was generated for your account

Attributes	Details
Type	`SecureString`
Required	Yes if Authentication Type is `Api Token`
Default value	Empty
Allowed values	Enter a `SecureString` or `SecureString` variable.
Notes	N/A

Username

The username that will be used for authentication

Attributes	Details
Type	`String`
Required	Yes if Authentication Type is `Api Token`
Default value	Empty
Allowed values	Enter a `String` or `String` variable.
Notes	N/A

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes	Details
Type	Checkbox
Required	No
Default value	Not Selected
Allowed values	Selected or Not Selected
Notes	N/A

Output

Jira Connection

A record of your established connection that you can use in other Jira Scope activities that are included in this scope activity.

Attributes	Details
Type	`JiraClient`
Required	No (recommended if you plan to have multiple Jira Scope activities within your project).
Default value	Empty
Allowed values	Enter a `JiraClient` variable.
Notes	You can pass this variable to a scope activity in a workflow that is invoked from within the parent scope activity. For example, you may have 3 workflows. The first includes the parent scope activity that establishes the connection to your registered application (i.e., parent workflow). The second workflow creates a new contact record and the third creates a new account record; both are included in the parent scope activity. When the workflows run, the parent scope activity passes the `JiraClient` variable to the existing connection JiraConnection property in the second and third workflows (see image below).

UiPath Marketplace

The UiPath Marketplace Guide

Jira Scope

How it works

Properties

Common

DisplayName

ContinueOnError

Authentication

Authentication Type

Server Url

Existing Jira Connection

Jira Connection

OAuth Authentication

Client ID

Client Secret

Token Authentication

Api Token

Username

Misc

Private

Output

Jira Connection

Jira Scope

Suggested Edits are limited on API Reference Pages