Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2023-06-23
Set Up Cloud Data Connect Databricks OAuth M2M Credentials

Set Up Cloud Data Connect Databricks OAuth M2M Credentials

This feature is released as Limited Availability for customers using S3 on AWS as their Cloud Object Storage for their Databricks. Contact your Named Support Contact to enable this feature. See Reference: Contact Us.
  • A Databricks cloud data warehouse environment.
  • Authentication and authorization details for the environment you want to connect to.
  • Access to a Databricks administrator who can perform the relevant credential, permissions, and views setup in the environment.
  • Security:
    • Integration Operator
       permission.
    • Data Designer
       permission
Cloud Data Connect (CDC) for Databricks connector supports OAuth machine-to-machine (M2M) authentication. You can create the OAuth M2M credential for CDC in Design Integrations. You then can select this credential in either the CDC pipeline interface or Cloud Data Source connections in Design Integrations.
For detailed guidance on Databricks configuration and setup, consult either:
  • The Databricks documentation.
  • Your Databricks admin or account manager.
  1. In Adaptive Planning, select
    Integrations
    Design Integrations
     from the main menu.
  2. Select
    Credentials
    Create New Credential
    .
  3. Select
    OAuth 2
     and then click
    Create
    .
  4. In
    Kind
    , select
    OAuth M2M
    .
  5. In Databricks, Create a service principal.
  6. Generate an OAuth secret for the service principal.
    Databricks issues the consumer key/client ID and the client secret for the service principal. Save these details to input into the credential in Adaptive.
  7. Configure the service principal with:
    • The right entitlements for the workspace
    • Appropriate permissions to the relevant cluster, SQL warehouse, specific catalogs or tables, and so on.
    • The correct resource-level access.
  8. In Adaptive Planning, enter these values for the OAuth 2 credential and save:
    • Consumer Key
       (Client ID)
    • Consumer Secret
    • Scope
      . If you leave this field blank, a default value of
      all-apis
       is applied on save.
    • Access Token Service Endpoint
      . Databricks refers to this as the
      workspace-level OAuth token endpoint
      . This is your Databricks workspace URL with
      /oidc/v1/token
       appended. Example:
      https://your-workspace.cloud.databricks.com/oidc/v1/token
      . For the current format, see Generate a workspace-level access token.
      To find the workspace URL, sign in to Databricks and look at your browser address bar. The workspace URL is everything before
      /?o=
      . Example: If you sign in to
      https://cust-success.cloud.databricks.com/?o=6280049833385130
      , then your workspace URL is
      https://cust-success.cloud.databricks.com.
      Use the workspace-level endpoint and not the account-level. The account-level endpoint is for account-wide API calls, not this integration.