Access Token for Jira Software

Configure an access token to connect to Jira Software.

Jira Access Token Configuration screen — Figure: Jira Software Access Token Configuration screen

Background and Setup

Examples

(Example) How to Get the Access Token Credentials from Jira Software

Prerequisites

One of these account types:
- Jira Software Basic account
- Jira Software Standard account
- Jira Software Premium account
AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v8.0 or higher.

Good to Know

To use the Jira Software process activities, your access token must have these credentials:

Activity Name	Required Permissions
Add Assignee	Browse Projects Assign issues
Add Attachment	Browse Projects Create attachments
Add Comments	Browse Projects Add comments
Create Issue	Browse Projects Create issues
Create Project	Administer Jira
Delete Issue	Browse Projects Delete issues
Get Issue Details	Browse Projects
Update Issue	Browse Projects Edit issues
Update Issue Status	Browse Projects Transition issues

For more information, refer to the Jira Software documentation in Third-Party Vendor Documentation.

In most cases, you can use a global access token or an app level access token:
- Global access tokens are shared across all users and apps. If you want all process designers and runtime app users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
- Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or runtime app users for a particular application should access an external system — for example, a Box account that is only used to share files within a small team.
Access tokens are collections of credentials that are used to authenticate communication directly between AgilePoint NX and an external system. Because it is the AgilePoint NX system that uses these credentials, rather than an app, there is no difference between design time and runtime access tokens. Access tokens are never checked in or published, and they do not use version control. If you change an access token in the App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to app level access tokens apply to all versions of an app, including running application instances. Changes to global access tokens apply everywhere they are used in AgilePoint NX. You can not roll back an access token to a previous version.
For more information, refer to What Data Is Deleted When I Delete an App or Application Resource?
OAuth 2.0 access tokens require a 2-way exchange of credentials between AgilePoint NX and the external service. This means that you must get the credentials from the third-party service to paste in the AgilePoint NX access token, and get the redirect URI from AgilePoint NX to paste in the external service. This requires you to open both the AgilePoint NX access token and the third-party service at the same time, so you can copy and paste from one screen to the other.
This topic shows the suggested procedure for Jira Software. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

(Example) How to Get the Access Token Credentials from Jira Software.
This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

There are several ways to create an access token for Jira Software. How to create the access token depends on where you want to use it.

Global (Manage Center)

You can use a global access token in any app in your AgilePoint NX tenant. Use a global access token if you want any user in your environment to be able to connect to the same external system.

Click Manage.
Click App Builder > Global Access Tokens.
On the Global Access Tokens screen, click Add Token.
On the Add Global Access Tokens screen, select Jira.
Click Next.

App Level (Process-Based App, Modern Add an App Experience)

Create an access token to use in any process activity or form control in a process-based app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create a process-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select Jira.
Click Next.

App Level (Form-Based App, Modern Add an App Experience)

Create an access token to use in any form control in a form-based app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create a form-based app.
For more information, refer to:
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select Jira.
Click Next.

App Level (App Explorer)

Create an access token to use in any process activity or form control in a specified app.

Click App Builder.
In the Application Explorer, on the My Apps pane, click [App Name] > Shared Resources > Access Tokens.
Click New.
On the New Access Token screen, select Jira.
Click Next.

Process Activities and Form Controls

Different access token types can be created in context and used in different process activities, form controls, or apps. The App Builder shows shortcut buttons in any place you can create an access token.

You can create an app level access token for Jira Software here:

Process Builder
- Any activity on the Jira Software tab

Fields

Field Name	Definition
Token Name	Function: Specifies the unique name for your connection to Jira Software. Accepted Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Jira Portal URL	Function: Specifies the base URL of your Jira Software site. The Jira portal URL comes from Jira Software. Accepted Values: One line of text (a string). Format: URL Default Value: None Example: https://customdomainname.atlassian.net/ Also refer to: (Example) How to Get the Access Token Credentials from Jira Software
Consumer Key	Function: Specifies the consumer key of the app you created or added in Jira Software. Accepted Values: One line of text (a string). Accepted: Letters Numbers Default Value: None Example: Refer to: (Example) How to Get the Access Token Credentials from Jira Software
Consumer Secret	Function: Specifies the consumer secret of the app you created or added in Jira Software. Accepted Values: One line of text (a string). Accepted: Letters Numbers Default Value: None Example: Refer to: (Example) How to Get the Access Token Credentials from Jira Software
Callback URL	Function: Specifies the callback URL from the connected application. Accepted Values: One line of text (a string). Format: URL Default Value: https://mysite.com/manage/shared/success.html Example: Refer to: (Example) How to Get the Access Token Credentials from Jira Software
Description	Function: A description for your access token. Accepted Values: More than one line of text. Default Value: None Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
OAuth 2.0 Access Token	Function: Specifies an OAuth 2.0 access token from Jira Software. Accepted Values: An OAuth 2.0 access token. This value comes from Jira Software. Default Value: None. Example: Refer to: (Example) How to Get the Access Token Credentials from Jira Software
Get OAuth 2.0 Access Token	Function: Sends a request to the Jira Software service to get the access token. To complete this process, you must sign in to Jira Software, and specify your consent when prompted.
Renewal Rate	Function: Specifies how frequently to renew your application's access token. Accepted Values: Disabled Every 15 minutes Every half an hour Every hour Default Value: Every hour