Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 account custom-app-integration command group within the Databricks CLI contains commands to manage custom OAuth app integrations. These integrations are required for adding and using custom OAuth apps like Tableau Cloud for Databricks in AWS cloud.
databricks account custom-app-integration create
Create a custom OAuth app integration.
databricks account custom-app-integration create [flags]
Options
--name string
Name of the custom OAuth app.
--confidential
This field indicates whether an OAuth client secret is required to authenticate this client.
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example creates a custom OAuth app integration using command-line flags:
databricks account custom-app-integration create --name "My Custom App" --confidential
The following example creates a custom OAuth app integration using JSON:
databricks account custom-app-integration create --json '{"name": "My Custom App", "redirect_urls": ["https://example.com/callback"], "confidential": true}'
The following example creates a custom OAuth app integration using a JSON file:
databricks account custom-app-integration create --json @custom-app.json
databricks account custom-app-integration delete
Delete an existing custom OAuth app integration.
databricks account custom-app-integration delete INTEGRATION_ID [flags]
Arguments
INTEGRATION_ID
The OAuth app integration ID.
Options
Examples
The following example deletes a custom OAuth app integration by ID:
databricks account custom-app-integration delete integration-abc123
databricks account custom-app-integration get
Get the custom OAuth app integration for the given integration ID.
databricks account custom-app-integration get INTEGRATION_ID [flags]
Arguments
INTEGRATION_ID
The OAuth app integration ID.
Options
Examples
The following example gets a custom OAuth app integration by ID:
databricks account custom-app-integration get integration-abc123
databricks account custom-app-integration list
Get the list of custom OAuth app integrations for the specified Databricks account.
databricks account custom-app-integration list [flags]
Options
--include-creator-username
Include the creator username in the response.
--page-size int
Number of results to return per page.
--page-token string
Token to retrieve the next page of results.
Examples
The following example lists all custom OAuth app integrations:
databricks account custom-app-integration list
The following example lists custom OAuth app integrations with pagination:
databricks account custom-app-integration list --page-size 10
The following example lists custom OAuth app integrations including creator usernames:
databricks account custom-app-integration list --include-creator-username
databricks account custom-app-integration update
Update an existing custom OAuth app integration.
databricks account custom-app-integration update INTEGRATION_ID [flags]
Arguments
INTEGRATION_ID
The OAuth app integration ID.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body
Examples
The following example updates a custom OAuth app integration using JSON:
databricks account custom-app-integration update integration-abc123 --json '{"name": "Updated App Name", "redirect_urls": ["https://example.com/new-callback"]}'
The following example updates a custom OAuth app integration using a JSON file:
databricks account custom-app-integration update integration-abc123 --json @update-custom-app.json
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