Jira
The following sections explain prerequisites, resources, and instructions for integrating with SaaS Management.
• | Stored Jira Information |
• | Required Minimum Permissions for Jira |
• | Jira Authentication Method |
• | Required Jira Credentials |
• | Jira License Types |
• | Integrating Jira With SaaS Management |
• | Auto-Populated Jira License Information |
• | Managing Available Jira Licenses |
• | Jira API Endpoints |
The following table describes the available integration tasks and stored data within SaaS Management.
Available Integration Tasks |
Information Stored |
|||||||||||||||
Application Roster |
Note:In the SaaS Management Users tab (SaaS > Managed SaaS Applications> Users), you may see a dash (-) displayed in the Email field for some users. This scenario occurs when the user signs in to the Jira instance portal and under Account settings > Profile and visibility selects the email dropdown list option view by me and admin. |
|||||||||||||||
Application Access |
|
|||||||||||||||
License Information |
|
Required Minimum Permissions for Jira
The minimum API required permissions are based on the Required Scopes for Jira and the Required Jira User Permission Profile.
Note:Consider the following:
• | The Jira required scopes provide read-only access to the API endpoints. You cannot perform any write actions. |
• | For more information on these required Jira scopes, see the Atlassian Developer Jira Cloud platform documentation topic, Jira Scopes for OAuth 2.0 (3LO) and Forge Apps. |
Scope |
Description |
Integration Task Name |
|||||||||
read:jira-user |
Enables you to view user information such as usernames and email. |
Application Roster |
|||||||||
read:user:jira read:audit-log:jira read:jira-work |
read:user:jira—Enables you to view user information. read:audit-log:jira—Enables you to view audit logs. read:jira-work—Enables you to:
|
Application Access |
|||||||||
read:license:jira |
Enables you to view licenses. |
License Information |
Required Jira User Permission Profile
Note:The following SaaS application user permission profile is not applicable to Flexera One roles.
User Permission Profile |
Description |
Product Admin |
Required to authenticate the Jira integration with SaaS Management and to generate the token every time the integration tasks run. The token that is generated and stored in SaaS Management contains read-only access to the API endpoints that are consumed. You cannot perform any other write actions. |
The required authentication method is OAuth 2.0 Three-Legged OAuth (3LO), also known as authorization code grants. For more information, see the Atlassian Developer Jira Cloud platform documentation topic, OAuth 2.0 (3LO) Apps.
The following credentials are required:
• | User Name |
• | Password |
• | Domain—This credential is required for authentication. |
Note:These credentials are required only for authorizing the application permissions. They are not stored in SaaS Management.
To learn more about the available Jira license types, see the Administering Jira Applications Support documentation topic, License Compatibility.
Integrating Jira With SaaS Management
Complete the following steps to integrate Jira with SaaS Management.
To integrate Jira with SaaS Management:
1. | Sign in to your Jira instance. |
2. | From the instance URL, note the Jira instance domain. For example, if the instance URL is https://test.atlassian.net, then the instance domain is test. |
Important:If you enter the Jira instance URL rather than the Jira instance domain in the SaaS Management Domain input field, the integration will fail.
3. | In SaaS Management, add the Jira application. For more information, see Adding an Application. |
4. | In the SaaS Management Add Application slideout: |
a. | From the Integration Tasks list, select the checkboxes for License Information, Application Access, and Application Roster. |
b. | Copy and paste the Jira instance domain into the Domain input field. |
c. | Click Authorize, which redirects you to the Jira portal. |
5. | In the Jira portal, sign in with the username and password that has the required minimum permission as mentioned in the Required Jira User Permission Profile. |
6. | On the Permissions consent page, click Accept to authorize and provide access to the account for the API endpoints used in the integration. |
7. | If you are required to select an option from the Choose a site dropdown list, select the site having the same domain name as entered in the SaaS Management Domain input field. Then click Accept. |
For further information on managing and optimizing your organization’s Jira licenses, see:
• | Auto-Populated Jira License Information |
• | Managing Available Jira Licenses. |
Auto-Populated Jira License Information
The SaaS Management integration with Jira offers a License Information integration task that automatically retrieves every 24 hours the name of the Jira plan and license type. This auto-populated Jira license information provides a more complete view of your Jira SaaS entitlements and component usage by displaying:
• | Assigned entitlements |
• | User’s license activity. |
Important:If you enable the License Information integration task, you need to enter and keep up to date the following Licenses Tab information. The License Information integration task does not pull in this information. The SaaS application’s annual spend calculation relies on entered and accurate license effective and expiration dates.
• | Effective Date |
• | Expiration Date |
• | Provisioned |
• | Cost |
• | Currency |
• | Payment Frequency |
To auto-populate Jira license information, see Auto-Populating SaaS Application License Information. When the License Information integration task is enabled, the License type and the Name fields in the Jira Licenses tab are disabled as this information is automatically populated.
Managing Available Jira Licenses
After the License Information integration task for Auto-Populated Jira License Information is enabled, you can add or remove the Jira product licenses you wish to manage within SaaS Management. To manage available Jira licenses, see Managing Available SaaS Application Licenses.
Application Roster
To get the cloud ID:
https://api.atlassian.com/oauth/token/accessible-resources
To get the Jira users:
https://api.atlassian.com/ex/jira/<cloud_Id>/rest/api/3/users/search
To get Jira product(s) assigned to users:
https://api.atlassian.com/ex/jira/<cloud_Id>/rest/api/3/user?expand=applicationRoles&accountId=<account_Id>
Application Access
To get the cloud ID:
https://api.atlassian.com/oauth/token/accessible-resources
Audit log API:
https://api.atlassian.com/ex/jira/<cloud_Id>/rest/api/3/auditing/record
Jira issue changelog API:
https://api.atlassian.com/ex/jira/<cloud_Id>/rest/api/2/search?expand=changelog
License Information
To get the cloud ID:
https://api.atlassian.com/oauth/token/accessible-resources
To get Jira products:
https://api.atlassian.com/ex/jira/<cloud_Id>/rest/api/3/instance/license