w.lakeview_embedded: Lakeview Embedded

class databricks.sdk.service.dashboards.LakeviewEmbeddedAPI

Token-based Lakeview APIs for embedding dashboards in external applications.

get_published_dashboard_embedded(dashboard_id: str)

Read a published dashboard in an embedded ui.

Get the current published dashboard within an embedded context.

Parameters:

dashboard_id – str UUID identifying the published dashboard.

get_published_dashboard_token_info(dashboard_id: str [, external_value: Optional[str], external_viewer_id: Optional[str]]) → GetPublishedDashboardTokenInfoResponse

Read an information of a published dashboard to mint an OAuth token.

Get a required authorization details and scopes of a published dashboard to mint an OAuth token. The authorization_details can be enriched to apply additional restriction.

Example: Adding the following authorization_details object to downscope the viewer permission to specific table ` { type: "unity_catalog_privileges", privileges: ["SELECT"], object_type: "TABLE", object_full_path: "main.default.testdata" } `

Parameters:

• dashboard_id – str UUID identifying the published dashboard.

• external_value – str (optional) Provided external value to be included in the custom claim.

• external_viewer_id – str (optional) Provided external viewer id to be included in the custom claim.

Returns:

GetPublishedDashboardTokenInfoResponse