Share via


recipient-activation 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 recipient-activation command group within the Databricks CLI contains commands to retrieve recipient activation information. This command group is only applicable in the open sharing model where the recipient object has the authentication type of TOKEN. The data recipient follows the activation link shared by the data provider to download the credential file that includes the access token. The recipient will then use the credential file to establish a secure connection with the provider to receive the shared data.

Note that you can download the credential file only once. Recipients should treat the downloaded credential as a secret and must not share it outside of their organization.

databricks recipient-activation get-activation-url-info

Get an activation URL for a share.

databricks recipient-activation get-activation-url-info ACTIVATION_URL [flags]

Arguments

ACTIVATION_URL

    The one time activation url. It also accepts activation token.

Options

Global flags

Examples

The following example gets activation URL information:

databricks recipient-activation get-activation-url-info "https://example.com/activation-url"

databricks recipient-activation retrieve-token

Get an access token with an activation url. This is a public API without any authentication.

databricks recipient-activation retrieve-token ACTIVATION_URL [flags]

Arguments

ACTIVATION_URL

    The one time activation url. It also accepts activation token.

Options

Global flags

Examples

The following example retrieves an access token:

databricks recipient-activation retrieve-token "https://example.com/activation-url"

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