Skip to main content

​
Requirements

To follow the steps in this guide, you’ll need:
  • In Omni:
  • A Databricks service account with access to all schemas and tables you want to use in Omni. This is required even when OAuth is enabled, because Omni uses the service account to build the model.
Before continuing, review the OAuth limitations.

​
Setup

1

Create a Databricks OAuth integration

Create an OAuth integration in Databricks using https://callbacks.omniapp.co/callback/oauth as the Redirect URI, then retrieve the Client ID and Client Secret.Refer to Databricks’s OAuth documentation for instructions.
For vanity-domain embeds: If you’re using OAuth with vanity-domain embeds, also add https://<your-vanity-domain>/oauth/callback as a Redirect URI. Replace <your-vanity-domain> with your vanity domain (e.g., omni.myapp.com).
2

Configure the connection in Omni

You must still configure a service account on this connection. Omni uses the service account to build the model, which provides the foundation for all user queries.
This guide assumes you have an existing Databricks connection in Omni. If you don’t, refer to Connecting a Databricks database for more information.
  1. In Omni, navigate to Settings > Connections and click on the Databricks connection you want to use.
  2. In the Authentication Type dropdown, select OAuth User Authentication.
  3. Enter the OAuth Client ID and OAuth Client Secret from the previous step into the respective fields.
  4. Save the connection settings.
3

Verify the user experience

After saving, each Omni user will be prompted to authenticate with Databricks the first time they run a query in a workbook or dashboard. This prompt reappears when their OAuth token expires.Once authenticated, Omni uses the user’s database permissions in place of the service account for all queries that user runs.

​
Next steps

To ensure database permissions align with what users see in Omni, we recommend implementing:
  • Access grants to control which fields and tables are visible to each user in the model and field browser
  • Content permissions to control which dashboards and documents users can access