Configure SCIM provisioning for Microsoft Azure Active Directory

Preview

This feature is in Public Preview.

To enable provisioning to Databricks using Azure Active Directory (Azure AD) you must create an enterprise application for each Databricks workspace.

Prerequisites

  • Your Databricks account must have the Premium plan (or, for customers who subscribed to Databricks before March 3, 2020, the Operational Security package).
  • Your Azure Active Directory account must be a Premium edition account.
  • You must be a global administrator for the Azure Active Directory account.

There are two ways to configure provisioning:

Use an Azure Active Directory enterprise application

In the following examples, replace <workspace-url> with the workspace URL of your Databricks deployment.

Create the enterprise application and connect it to the Databricks SCIM API

  1. Generate a personal access token in Databricks and copy it. You provide this token to Azure Active Directory in a subsequent step.

    Important

    Generate this token as a Databricks admin who is not managed by the Azure Active Directory enterprise application. If the Databricks admin user who owns the personal access token is deprovisioned using Azure Active Directory, the SCIM provisioning application will be disabled.

  2. In your Azure portal, go to Azure Active Directory > Enterprise Applications.

  3. Click + New Application above the application list. Under Add from the gallery, search for and select Azure Databricks SCIM Provisioning Connector.

  4. Enter a Name for the application and click Add. Use a name that will help administrators find it, like <workspace-name>-provisioning.

  5. Under the Manage menu, click Provisioning.

  6. Set Provisioning Mode to Automatic.

  7. Enter the SCIM API endpoint URL. Append /api/2.0/preview/scim to your workspace URL:

    https://<workspace-url>/api/2.0/preview/scim
    

    Replace <workspace-url> with the workspace URL of your Databricks deployment. See Get workspace, cluster, notebook, model, and job identifiers.

  8. Set Secret Token to the Databricks personal access token that you generated in step 1.

  9. Click Test Connection and wait for the message that confirms that the credentials are authorized to enable provisioning.

  10. Optionally, enter a notification email to receive notifications of critical errors with SCIM provisioning.

  11. Click Save.

Assign users and groups to the application

  1. Go to Manage > Provisioning.

  2. Under Settings, set Scope to Sync only assigned users and groups.

    Databricks recommends this option, which syncs only users and groups assigned to the enterprise application.

    Note

    Azure Active Directory does not support the automatic provisioning of nested groups to Databricks. Azure Active Directory can only read and provision users that are immediate members of the explicitly assigned group. As a workaround, explicitly assign (or otherwise scope in) the groups that contain the users who need to be provisioned. For more information, see this FAQ.

  3. To start synchronizing Azure Active Directory users and groups to Databricks, click the Provisioning Status toggle.

  4. Click Save.

  5. Test your provisioning setup:

    1. Go to Manage > Users and groups.
    2. Add some users and groups. Click Add user, select the users and groups, and click the Assign button.
    3. Wait a few minutes and check that the users and groups exist in your Databricks workspace.

In the future, users and groups that you add and assign are automatically provisioned when Azure Active Directory schedules the next sync.

Important

Do not assign the Databricks admin whose personal access token was used to configure the Azure Databricks SCIM Provisioning Connector application.

Automate SCIM provisioning using Microsoft Graph

Microsoft Graph includes authentication and authorization libraries that you can integrate into your application to automate provisioning of users and groups to Databricks, instead of configuring a SCIM provisioning connector application.

  1. Follow the instructions for registering an application with Microsoft Graph. Make a note of the Application ID and the Tenant ID for the application
  2. Go to the applications’s Overview page. On that page:
    1. Configure a client secret for the application, and make a note of the secret.
    2. Grant the application these permissions:
      • Application.ReadWrite.All
      • Application.ReadWrite.OwnedBy
  3. Ask an Azure Active Directory administrator to grant admin consent.
  4. Update your application’s code to add support for Microsoft Graph.

Provisioning tips

  • Users and groups that existed in Databricks prior to enabling provisioning exhibit the following behavior upon provisioning sync:
    • Are merged if they also exist in Azure Active Directory
    • Are ignored if they don’t exist in Azure Active Directory
  • User permissions that are assigned individually and are duplicated through membership in a group remain after the group membership is removed for the user.
  • Users removed from a Databricks workspace directly, using the Databricks Admin console:
    • Lose access to that Databricks workspace but may still have access to other Databricks workspaces.
    • Will not be synced again using Azure Active Directory provisioning, even if they remain in the enterprise application.
  • The initial Azure Active Directory sync is triggered immediately after you enable provisioning. Subsequent syncs are triggered every 20-40 minutes, depending on the number of users and groups in the application. See Provisioning summary report in the Azure Active Directory documentation.
  • You cannot update the username or email address of a Databricks user.
  • The admins group is a reserved group in Databricks and cannot be removed.
  • Groups cannot be renamed in Databricks; do not attempt to rename them in Azure Active Directory.
  • You can use the Databricks Groups API 2.0 or the Groups UI to get a list of members of any Databricks group.

Troubleshooting

Users and groups do not sync

  • If you are using the Azure Databricks SCIM Provisioning Connector application: In the Databricks admin console, verify that the Databricks user whose personal access token is being used by the Azure Databricks SCIM Provisioning Connector application is still an admin user in Databricks and that the token is still valid.
  • Do not attempt to sync nested groups, which are not supported by Azure Active Directory automatic provisioning. For more information, see this FAQ.

After initial sync, the users and groups stop syncing

If you are using the Azure Databricks SCIM Provisioning Connector application: After the initial sync, Azure Active Directory does not sync immediately after you change user or group assignments. It schedules a sync with the application after a delay, based on the number of users and groups. To request an immediate sync, go to Manage > Provisioning for the enterprise application and select Clear current state and restart synchronization.

Azure Active Directory provisioning service IP range not accessible

The Azure Active Directory provisioning service operates under specific IP ranges. If you need to restrict network access, you must allow traffic from the IP addresses for AzureActiveDirectory in this IP range file. For more information, see IP Ranges.