Learn how to set up the connection between Atlassian Jira Cloud and Clarity Security, how to collect the keys, and how to configure the connector in the Clarity Security platform.

Estimated time to complete: 10 minutes

If you run into any complications, please reach out to your support team or support@claritysecurity.io.

If there are discrepancies between your experience and this documentation, please reach out to documentation@claritysecurity.io.

Pre-Requisites

Admin access to Atlassian Jira Cloud
1. Note: If you do not have admin access, reach out to your Atlassian Jira Cloud admin for provisioning.
Admin access to Clarity Security
1. Note: If you are a full admin in Clarity Security and get a permission error when trying to add a new application, reach out to support@claritysecurity.io.

Supported Methods

Method	Supported?	Atlassian Cloud Additional Requirements
Provision User	No	N/A
List Entitlements, Groups, Resources and Permissions	No	N/A
Add User to Entitlements, Groups, Resources and Permissions	No	N/A
Remove User from Entitlements, Groups, Resources and Permissions	No	N/A
Deactivate User	No	N/A
Delete User	No	N/A
Self-Service Access Request	No	N/A

How to Set Up the Connector

1. Head to https://developer.atlassian.com and sign in.

2. Once signed in, click on the user profile picture in the top right corner and choose Developer Console.

3. Click the Create button above the list of API connections (this list may be empty) and in the sub menu choose “OAuth 2.0 Integration”

4. Give a name to the new API connection, make sure this is descriptive enough in the event you have future API connections (or to distinguish from pre-existing ones). Check the box agreeing to the Atlassian Developer terms, and then click Create.

5. Now that your connection is created, you should be automatically loaded into the Settings page for the new connector. Click on the “Permissions” button on the left side.

6. On the permissions page, click Add (this changes to Configure after you make changes) next to the line stating Jira API.

7. Click Edit Scopes under the Platform REST API section, ensure you are under Classic not Granular scopes.

8. Click the checkboxes for “Manage Jira global settings” and “View user profiles”, and then click Save.

9. On the permissions page, click Add (this changes to Configure after you make changes) next to the line stating Confluence API.

10. Click Edit Scopes under the Platform REST API section, ensure you are under Classic not Granular scopes.

11. Click the checkboxes for “Manage Confluence Space Details”, “Manage Confluence Global Settings”, "Read User", "Read User Groups", "Create, Remove, and Update User Groups" and then click Save.

12. On the left-hand side click Authorization (Should be directly below the Permissions button from Step 5). Click the “Add” button on the line for OAuth 2.0 (3LO).

13. Fill out the “Callback URL” for your integration using the following link. You must replace “YOUR_DOMAIN” with the first part of your Clarity Security URL.

https://YOUR_DOMAIN.claritysecurity.io/application/oauthProcessCode/atlassian-jira

14. Now navigate to “Settings”, again on the left side.

15. Scroll to the bottom of the page and capture the Client ID and Secret, these will be required to put in the Clarity Security app integration.

16. To collect the final piece of information necessary for the application integration, head to https://admin.atlassian.com/ and log in. Select the correct organization for your account to log in to that instance of Atlassian.

17. Once you have completely logged into your instance, click on settings > API Keys

18. Click "Create API Key" > Name you key something descriptive, and change the expiration date to 1 year from the current date > Click "Create"

19. Copy the Organization ID and API Key that appears.

20. Log into your Clarity Security portal, and head to the Applications Section and click “Marketplace”. To connect to your Jira Cloud instance, search for “Atlassian Jira Cloud”

21. Copy the information you gathered in steps 12 and 14 to fill out the boxes. Once you hit “Validate” you will be taken to a page for authenticated login.

22. You will need to login to Atlassian with the account used to create the app in steps 1 - 15 to complete the validation for Clarity

23. Once you are logged in you must approve for Clarity to have permission to read and write to Atlassian.

24. Fill out the final Yes and No boxes per your organization's needs, see the chart above (near the top) to confirm the settings below are supported by the application.

Support Contact Information

Contact your customer success team.
Email support@claritysecurity.io
Open a ticket Here
Call 979-398-5512 – Monday - Friday – 8:00 AM-6:30 PM CST