How to set up social connection with Atlassian
Adding social connection with Atlassian to your app with Clerk is done in a few steps - you will need to populate the Client ID, Client Secret and Authorized redirect URI in your instance settings.
To make the development flow as smooth as possible, Clerk uses preconfigured shared OAuth credentials and redirect URIs for development instances - no other configuration is needed.
For production instances, you will need to generate your own Client ID and Client Secret using your Atlassian account.
The purpose of this guide is to help you create an Atlassian account and an Atlassian OAuth 2.0 Integration - if you're looking for step-by-step instructions using Clerk to add social connection (OAuth) to your application, follow the Social connection (OAuth) guide.
Before you start
- You need to create a Clerk Application in your Clerk Dashboard(opens in a new tab). For more information, check out our Set up your application guide.
- You need to have a Atlassian developer account. To create one, click here(opens in a new tab).
Configuring an Atlassian OAuth 2.0 Integration
You can navigate to the list of all your apps(opens in a new tab) to select an existing app or create a new one:
From there, click on the desired existing app or create a new one, which will take you to the app page.
While not necessary for the integration to work, you can edit your app name, description and set a logo for it in the Settings tab.
From the app page, click on the Permissions tab in the sidebar menu.
Here, you will need to configure the OAuth 2.0 scopes that should be requested from your users when they attempt to connect with Atlassian.
At the very minimum, you will need to enable the User identity API, which corresponds to the
read:me OAuth 2.0 scope. This enables Clerk to retrieve basic user profile info when creating users for your app.
Afterwards, you will need to set up the Callback URL so that Atlassian can redirect back to your Clerk app upon successful connection.
This is done by navigating to the Authorization section and clicking on Add.
In this section, you will need to paste the Authorized redirect URI that Clerk has provided for you.
After entering the callback URL, the Client ID & Client Secret will now be available in the Settings tab:
You will need to copy these values and paste:
- The Atlassian Client ID to the Client ID input on Clerk
- The Atlassian Client Secret to the Client Secret input on Clerk
If you have enabled further scopes on Atlassian, you can add them in the Clerk Atlassian configuration settings as well. This will affect the tokens that Atlassian issues to you, so that you can access the intended Atlassian resources.
Finally, you will need to make your Atlassian app publicly accessible, since it starts out as private by default. This is done from the Distribution tab:
After clicking on Edit, you will need to provide the following information and save the form:
- Set the distribution status to Sharing
- Enter your vendor name
- Enter a link to yout terms page
- Add a contact page link (optional)
- Indicate that your data does store data, since at the very least the user profile info is used to create users on the Clerk end
- To be able to connect, the user must have access to at least one Atlassian site (e.g. JIRA, Confluence)
- Currently the user can authorize access only to a single Atlassian site
Congratulations! Social connection with Atlassian is now configured for your instance.
Last updated on October 3, 2023