Manage dashboard embedding

This page shows how workspace admins can manage dashboard embedding options for AI/BI dashboards.

What types of embedding can you do?

You can securely embed dashboards in external websites and applications. You can embed dashboards in the following ways:

• Databricks-basic embedding: Dashboard authors can generate iframe embed code using the Share dialog. Workspace admins can manage which domains, if any, are approved for hosting an embedded dashboard. Dashboard embedding requires users to have third-party cookies enabled. Workspace admins must enable embedding in the workspace and define the list of eligible domains. See Basic dashboard embedding.

• Embedding for external users: (Public Preview) You can configure an external application to authenticate to Databricks with a service principal and access a dashboard. Users who are able to access your external application can access the dashboard. Optionally, you can filter the data presented in the dashboard based on the user who is accessing it. Workspace admins must configure the external application to use the service principal and OAuth tokens required for authentication. See What is embedding for external users?.

To learn more about available embedding options, see Embed a dashboard.

Control allowed embed destinations

Either option to embed a dashboard requires that the external website be explicitly allowed. To add allowed embed destinations to your workspace:

1. Click your username in the top bar of the Databricks workspace and select Settings.

2. Click Security.

3. Scroll down to the External access section.

4. In the Embed dashboards section, use the drop-down menu to set the policy for your workspace.

   There are three policy options:

   • Allow: Dashboards can be embedded in any domain.
   • Allow approved domains: Dashboards can only be embedded in sites that match the approved list.
   • Deny: Dashboards cannot be embedded in any domain.

If you select Allow approved domains, use the following instructions to manage your list of approved domains:

1. Click Manage next to Embed Dashboards.
2. Type a domain in the Approved domain dialog's text field. Click Add domain after each entry.
3. Click Save.

note

To embed your dashboard in a Google Site, you must allow multiple domains owned and used by Google in addition to the address associated with your particular site. The required sites are:

• sites.google.com
• www.gstatic.com
• *.googleusercontent.com

Tips for defining approved domains and routes

To specify allowed hosts, use the grammar defined in W3C's Content Security Policy documentation. The examples in this section illustrate some common patterns.

Allow subdomains

To allow all subdomains for a given domain, use a wildcard symbol (*) before the domain name. The following examples use *.databricks.com as a sample domain.

• Matches: Any subdomain
  • some.databricks.com
  • app.databricks.com
  • anything.databricks.com
• Does not match: Anything that has a different domain.
  • another-databricks.com
  • app-databricks.com

What's next

• Set up basic embedding: Configure embedding for users with Databricks accounts who can sign in directly to view dashboards. See Basic dashboard embedding.
• Configure embedding for external users: Set up embedding for external users to allow users without Databricks accounts to access dashboards through service principal authentication. See What is embedding for external users?.
• Create and publish dashboards: Learn how to create, configure, and publish AI/BI dashboards for embedding. See Dashboards.
• Manage workspace security settings: Configure additional security settings and access controls for your workspace. See Manage your workspace.