lakeview-embedded command group

note

This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The lakeview-embedded command group within the Databricks CLI provides token-based Lakeview APIs for embedding dashboards in external applications.

databricks lakeview-embedded get-published-dashboard-token-info

Read information of a published dashboard to mint an OAuth token. Gets the required authorization details and scopes of a published dashboard to mint an OAuth token.

databricks lakeview-embedded get-published-dashboard-token-info DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifying the published dashboard.

Options

--external-value string

    Provided external value to be included in the custom claim.

--external-viewer-id string

    Provided external viewer ID to be included in the custom claim.

Global flags

Examples

The following example gets token info for a published dashboard:

Bash

databricks lakeview-embedded get-published-dashboard-token-info 12345678-1234-1234-1234-123456789012

The following example gets token info with an external viewer ID:

Bash

databricks lakeview-embedded get-published-dashboard-token-info 12345678-1234-1234-1234-123456789012 --external-viewer-id "user-123"

Global flags

--debug

  Whether to enable debug logging.

-h or --help

    Display help for the Databricks CLI or the related command group or the related command.

--log-file string

    A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.

--log-format format

    The log format type, text or json. The default value is text.

--log-level string

    A string representing the log format level. If not specified then the log format level is disabled.

-o, --output type

    The command output type, text or json. The default value is text.

-p, --profile string

    The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.

--progress-format format

    The format to display progress logs: default, append, inplace, or json

-t, --target string

    If applicable, the bundle target to use