Tutorial: Configure Atlassian Cloud for automatic user provisioning

This tutorial describes the steps you need to perform in both Atlassian Cloud and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Atlassian Cloud using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.

Capabilities supported

  • Create users in Atlassian Cloud
  • Remove users in Atlassian Cloud when they do not require access anymore
  • Keep user attributes synchronized between Azure AD and Atlassian Cloud
  • Provision groups and group memberships in Atlassian Cloud
  • Single sign-on to Atlassian Cloud (recommended)

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

  • An Azure AD tenant.

  • A user account in Azure AD with permission to configure provisioning (e.g. Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).

  • Make sure you're an admin for an Atlassian organization. See Organization administration..

  • Verify one or more or your domains in your organization. See Domain verification.

  • Subscribe to Atlassian Access from your organization. See Atlassian Access security policies and features.

  • An Atlassian Cloud tenant with an Atlassian Access subscription.

  • Make sure you're an admin for at least one Jira or Confluence site that you want to grant synced users access to.

    Note

    This integration is also available to use from Azure AD US Government Cloud environment. You can find this application in the Azure AD US Government Cloud Application Gallery and configure it in the same way as you do from public cloud.

Step 1. Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Azure AD and Atlassian Cloud.

Step 2. Configure Atlassian Cloud to support provisioning with Azure AD

  1. Navigate to Atlassian Admin Console. Select your organization if you have more than one.

  2. Select Settings > User provisioning. Screenshot showing the User Provisioning tab.

  3. Select Create a directory.

  4. Enter a name to identify the user directory, for example Azure AD users, then select Create. Screenshot showing the Create directory page.

  5. Copy the values for Directory base URL and API key. You'll need those for your identity provider configuration later.

    Note

    Make sure you store these values in a safe place, as we won't show them to you again.

    Screenshot showing the API key page.

    Users and groups will automatically be provisioned to your organization. See the user provisioning page for more details on how your users and groups sync to your organization.

Add Atlassian Cloud from the Azure AD application gallery to start managing provisioning to Atlassian Cloud. If you have previously setup Atlassian Cloud for SSO you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.

Step 4. Define who will be in scope for provisioning

The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

  • If you need additional roles, you can update the application manifest to add new roles.

Step 5. Configuring automatic user provisioning to Atlassian Cloud

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Atlassian Cloud based on user and/or group assignments in Azure AD.

To configure automatic user provisioning for Atlassian Cloud in Azure AD:

  1. Sign in to the Azure portal and select Enterprise Applications, select All applications, then select Atlassian Cloud.

    Enterprise applications blade

  2. In the applications list, select Atlassian Cloud.

    The Atlassian Cloud link in the Applications list

  3. Select the Provisioning tab.

    Screenshot of the Manage options with the Provisioning option called out.

  4. Set the Provisioning Mode to Automatic.

    Screenshot of the Provisioning Mode dropdown list with the Automatic option called out.

  5. Under the Admin Credentials section, input the Tenant URL and Secret Token retrieved earlier from your Atlassian Cloud's account. Click Test Connection to ensure Azure AD can connect to Atlassian Cloud. If the connection fails, ensure your Atlassian Cloud account has Admin permissions and try again.

    Tenant URL + Token

  6. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and check the checkbox - Send an email notification when a failure occurs.

    Notification Email

  7. Click Save.

  8. Under the Mappings section, select Synchronize Azure Active Directory Users to Atlassian Cloud.

  9. Review the user attributes that are synchronized from Azure AD to Atlassian Cloud in the Attribute Mapping section. The email attribute will be used to match Atlassian Cloud accounts with your Azure AD accounts. Select the Save button to commit any changes.

    Attribute Type
    userName String
    active Boolean
    name.familyName String
    name.givenName String
    emails[type eq "work"].value String
  10. Under the Mappings section, select Synchronize Azure Active Directory Groups to Atlassian Cloud.

  11. Review the group attributes that are synchronized from Azure AD to Atlassian Cloud in the Attribute Mapping section. The display name attribute will be used to match Atlassian Cloud groups with your Azure AD groups. Select the Save button to commit any changes.

    Attribute Type
    displayName String
    externalId String
    members Reference
  12. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  13. To enable the Azure AD provisioning service for Atlassian Cloud, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  14. Define the users and/or groups that you would like to provision to Atlassian Cloud by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

  15. When you are ready to provision, click Save.

    Saving Provisioning Configuration

This operation starts the initial synchronization of all users and/or groups defined in Scope in the Settings section. The initial sync takes longer to perform than subsequent syncs, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.

Step 6. Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

  1. Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
  2. Check the progress bar to see the status of the provisioning cycle and how close it is to completion
  3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

Connector Limitations

  • Atlassian Cloud only supports provisioning updates for users with verified domains. Changes made to users from a non-verified domain will not be pushed to Atlassian Cloud. Learn more about Atlassian verified domains [here] (https://support.atlassian.com/provisioning-users/docs/understand-user-provisioning/).
  • Atlassian Cloud does not support group renames today. This means that any changes to the displayName of a group in Azure AD will not be updated and reflected in Atlassian Cloud.
  • The value of the mail user attribute in Azure AD is only populated if the user has a Microsoft Exchange Mailbox. If the user does not have one, it is recommended to map a different desired attribute to the emails attribute in Atlassian Cloud.

Change log

  • 06/15/2020 - Added support for batch PATCH for groups.
  • 04/21/2021 - Added support for Schema Discovery.

Additional resources

Next steps