To integrate Jira Cloud and Atlan, follow these steps.
Connect Atlan to Jira Cloud
Atlan uses the following scopes for the Jira Cloud integration:
-
read:jira-user
— view user profiles -
read:jira-work
— view Jira issue data -
write:jira-work
— create and manage Jira issues -
manage:jira-configuration
— manage Jira global settings -
offline_access
— allows the Atlan app to refresh the access token
To connect Atlan to Jira Cloud from within Atlan:
- From the left menu, click Admin.
- Under Workspace, click Integrations.
- In the Jira tile, click the Connect button.
- A new window will open, where you'll be asked to log into your Atlassian account:
- To login with an email address, enter your email address, click Continue, and then enter your password and click Log in.
- To login with Google, Microsoft, or Apple, click the appropriate button and follow the instructions.
- Once you're logged in, you will be asked to allow Atlan to access your Atlassian account. Scroll to the bottom of the window and click the Accept button.
- If you have access to multiple Jira Cloud sites, for the Connecting to Jira dialog, click the Select environment dropdown to select the Jira environment you want to connect to Atlan and then click Connect.
Install Atlan Jira app
To install the Atlan Jira app:
- Open the Atlan Jira app's page in the Atlassian marketplace, through either of these ways:
- From the Integrations page of Atlan, in the Jira tile, click the Add to Jira button.
- Directly navigate to the URL: https://marketplace.atlassian.com/apps/1225577/atlan
- In the upper right of the page, click the Get it now button.
- At the bottom of the Add to Jira dialog, click the Get it now button.
(Optional) Request permission from your Jira Cloud admin
If you are not a workspace administrator in Jira, you will be prompted to request permission to install. To request permission to install the integration:
- Under Want this app? Let your admin know why enter an explanation for installing the app.
- At the bottom of the form, click the Submit request button.
- Contact your Jira workspace administrator and ask them to approve the Atlan app.
- Once approved, you'll get an email from Jira telling you that the Atlan app is installed.
Configure integration from Atlan to Jira Cloud
To configure the Jira Cloud integration from Atlan, from the Integrations sub-menu:
- Expand the Jira tile. (You may need to refresh the page before the following options appear.)
- Under the Configurations tab, you can configure the following:
- For Projects and issue type, select the Jira projects for which your users are allowed to create tickets in Atlan. For each selected project, next to Issue types, click Edit to select the allowed issue types. (This will default to all projects and issue types, if none are specified.)
- For Default Project, select the Jira project to use as your default project from the allowed list of projects.
- Click Update to save your configuration.
- (Optional) At any future time, you can review the Overview tab to see the number of linked issues between Jira and Atlan.
Atlan is now connected to Jira Cloud! 🎉
(Optional) Create a webhook for access management workflows
If your Atlan admin has enabled the governance workflows and inbox module in your Atlan workspace, you can either register a webhook in the Jira administration console or install it directly in Atlan to allow your requesters to view the latest status of their data access approval or revocation requests for governed assets.
This is only required if you:
- Enable governance workflows.
- Want to use the access management workflow to grant or revoke data access in a source tool using Jira.
In addition to the scopes mentioned here, Atlan uses the following scope to manage Jira webhooks — manage:jira-webhook
.
From Atlan
You can directly install the webhook in Atlan if you're an admin in both your Atlan and Jira Cloud workspaces.
To install a webhook:
- From the left menu, click Admin.
- Under Workspace, click Integrations.
- Expand the Jira tile. For Get updates on data access requests (optional), click Install. Atlan will automatically install the webhook.
From Jira
Your Jira admin will need to register the webhook in the Jira administration console if your Atlan admin is not a Jira admin.
To register a webhook:
- Contact Atlan support to provide you with the webhook secret.
- Log in to the Jira administration console with the Administer Jira global permission.
- From the top right of the Jira administration console, open the settings menu, and then under Jira Settings, click System.
- From the left menu, under Advanced, click WebHooks.
- From the top right of your screen, click the Create a WebHook button.
- In the webhook creation form, enter the following details:
- For Name, enter a meaningful name — for example,
Atlan_webhook
. - For Status, click Enabled.
- For URL, copy and paste
https://{atlan-domain}.com/api/service/jira/events
— replaceatlan-domain
with the name of your Atlan tenant. - For Secret, enter the webhook secret provided by Atlan support. Note that if an invalid secret is used or this field is kept blank, the webhook configuration will be automatically removed from Atlan once an event is received in Atlan.
- Under Events, in the text box for Issue related events, paste
issue.property[atlan].guid is NOT EMPTY
. - For Issue, click the checkboxes for updated (jira:issue_updated) and deleted (jira:issue_deleted).
- Skip the rest of the fields. Click Create to register your webhook.
- For Name, enter a meaningful name — for example,