Important Update Effective February 1, 2024!
Due to recent changes in Jira and Confluence, we've made the tough decision to discontinue the OpenID Connect (OIDC)/OAuth app and no longer provide new versions for the newest Jira/Confluence releases as of January 31, 2024.
This is due to some necessary components no longer shipping with Jira/Confluence, which would require some extensive rewrites of the OIDC App.
Important Update! This app will be discontinued soon!
Due to recent changes in Jira, which no longer ships with some components required for our Read Receipts app to run, we've made the tough decision to discontinue the app, as of Februar 5, 2025.
Important Update! This app will be discontinued soon!
We've made the tough business decision to discontinue the app, as of January 11, 2025.
Microsoft Entra ID (formerly Azure AD) configuration
Azure Active Directory is now Microsoft Entra ID (https://learn.microsoft.com/en-gb/entra/fundamentals/new-name).
This page contains information about how to set up Microsoft Entra ID and User & Group Sync for Atlassian Server or Data Center applications.
When you encounter different wording, please contact us and we will update the documentation.
Video Guide
Quickstart guide
Go to portal.azure.com, click "Microsoft Entra ID" in the left panel and then choose "App registrations".
- Click on "New registration"
- Enter a "Name" for the app.
- Click on "Register".
- On this page you can see the "Application ID" and the "Directory (tenant) ID". You will need both to setup the Azure AD connector in User Sync.
- Click on "API permissions" in the left panel.
- Delete the default created permission since it's not needed.
- Click on "Add a permission" and choose "Microsoft Graph".
- Click on "Application Permissions".
- Search for the "Directory" entry, expand it and tick "Directory.Read.All".
- Click on "Add permissions" to add the permissions.
- Click on "Grant admin consent for ...".
- Next, click on "Certificate & secrets".
- Add a new Client secret by click on "New client secret".
- Enter a description for the secret and also set an expiry date. Click on Add to confirm.
- Copy the secret now ("VALUE"). You are not able to see it again after leaving that page. Please paste it to a text editor for the tutorial.
Now it is time to configure User & Group Sync in your Atlassian Server or Data Center product. Please keep the Azure website open, because we will need it later on.
- Now, go back to your Atlassian Server or Data Center product, and go to the User & Group Sync Configuration.
- Click Create Connector and choose Azure.
- First, paste the client secret (which you copied before) into the Application Secret.
- Next, go back to the Azure website and click Properties in the app you have created for User & Group Sync. Copy the Application ID and Directory (Tenant) ID and paste them into the User & Group Sync configuration in your Atlassian product.
- In the User & Group Sync configuration under the Sync Settings tab, activate Scheduled Synchronization. You can edit the Cron expression to set a synchronisation interval.
User guide
Go to http://portal.azure.com and click the Microsoft Entra ID.
In the Microsoft Entra ID click App registrations.
Click New registration to create a new app.
Enter a name for your application and click on Register to proceed.
Click API permissions in the left panel.
Delete the default created permission since it's not needed.
Click on Add a permission.
Select Microsoft Graph.
Choose Application permissions.
Expand Directory and tick Directory.Read.All
From SAML version 6.3.0 or User Sync 2.7.0 User Sync also supports syncing the profile pictures of users in Azure AD. To be able to use this feature, you additionally need to add User.Read.All as permission.
Click on "Grant admin consent for ...".
It should look like this after granting admin consent:
For the next step, click on Certificates & secrets in the left panel, and then click on New client secret.
Enter a description for the secret and also set an expiry date. Click on Add to confirm.
Please note that your secret will expire after 24 months. If syncs start failing in 24 months, you must create a new secret and update the secret in the connector.
Your Client secret will display only once, thus copy the secret. Of course, it is possible to create a new secret, if you lost your secret.
Go overview page of the Microsoft Entra ID app. Copy the Application ID and the Directory (tenant ID). Now, it is time to head over to your Atlassian application.
In your Atlassian application, go to User Sync, click Create Connector, and choose Azure.
Add the Application ID, Directory ID, and the Application secret. Use the Save and Test Connection button to check whether Azure's API endpoints are reachable and API permissions are set correctly.
To take full advantage of User Sync, go to the Sync Settings tab and enable "Scheduled Synchronization". You can control the sync interval via a Cron Expression.
Do not forget to save your configuration by clicking on "Save and Return".
You are now ready to commence either a simulated or a full sync. By simulating the sync first you will be able to verify your configuration and see what changes User Sync would apply like what users will be added, modified, or not modified. With the full sync, User Sync will apply those changes. Both sync actions will run a full sync and will have the same sync duration. For more information on the sync simulation, please refer to Using the Simulated Sync Feature.
Additional Resources:
- User Sync Endpoints
- Group Management- And Filtering With User Sync
- Cleanup Behaviour and Scheduled Synchronization
- How To Migrate An Internal Directory To UserSync