This connection requires the following parameters:
- Service Principal Client ID - Application/Client ID from Databricks
- Service Principal Client Secret - OAuth secret generated in Databricks
- Workspace URL - Your Databricks workspace URL
- Account ID (Optional) - Required for account-level access to multiple workspaces
Use Case: Access to one specific workspace only
- Go to your Databricks workspace (e.g.,
https://your-workspace.cloud.databricks.com
)
- Click the Settings gear icon (⚙️) in the left sidebar
- Navigate to Identity and Access → Service Principals
- Click "Add Service Principal"
- Provide a display name (e.g., "API Client", "Data Integration")
- Click "Add"
- Click on your newly created service principal
- Go to the "Credentials" tab
- Click "Generate Secret"
- Copy and save the Client Secret (you won't see it again)
- Copy the Application ID (Client ID)
- In the service principal details, go to "Permissions" tab
- Click "Add permissions"
- Grant yourself "Service Principal: User" role (this allows you to use the service principal)
- Optionally grant access to specific resources (clusters, jobs, data)
Result: Service principal can access only this workspace
Official Documentation: Databricks Service Principals
Use Case: Access to multiple workspaces and account-level operations
Requirements: Account Admin access required
- Go to Databricks Account Console:
https://accounts.cloud.databricks.com
- Login with Account Admin credentials
- Navigate to User Management → Service Principals
- Click "Add Service Principal"
- Choose "Create new service principal"
- Provide a display name (e.g., "Cross-Workspace API Client")
- Click "Add"
- Click on your newly created service principal
- Click "Generate secret"
- Copy and save the Client Secret immediately
- Copy the Application ID (Client ID)
- In the service principal details, click "Permissions"
- Grant account-level roles:
- Account Admin (full access to all workspaces)
- OR Workspace Creator (can list and access workspaces)
- OR custom roles as needed
- In the Account Console, click your profile (top right)
- Copy the Account ID from the profile dropdown
- Or check the URL:
https://accounts.cloud.databricks.com/accounts/{account-id}
- Go to Workspaces in Account Console
- For each workspace, click "Manage"
- Add the service principal to workspace with appropriate permissions
Result: Service principal can access multiple workspaces and account-level APIs
Official Documentation: