account iam-v2 command group
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
The account iam-v2 command group within the Databricks CLI contains commands to manage identities and the workspace access of these identities in Databricks.
databricks account iam-v2 get-workspace-access-detail
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Get workspace access details for a principal.
This command returns the access details for a principal in a workspace. It allows for checking access details for any provisioned principal (user, service principal, or group) in a workspace. A provisioned principal is one that has been synced into Databricks from the customer's identity provider or added explicitly to Databricks via SCIM/UI.
databricks account iam-v2 get-workspace-access-detail WORKSPACE_ID PRINCIPAL_ID [flags]
Arguments
WORKSPACE_ID
Required. The workspace ID for which the access details are being requested.
PRINCIPAL_ID
Required. The internal ID of the principal (user/service principal/group) for which the access details are being requested.
Options
--view WorkspaceAccessDetailView
Controls what fields are returned. Supported values: BASIC, FULL.
databricks account iam-v2 resolve-group
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Resolve an external group in the Databricks account.
This command resolves a group with the given external ID from the customer's identity provider. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this command will return an error.
databricks account iam-v2 resolve-group EXTERNAL_ID [flags]
Arguments
EXTERNAL_ID
Required. The external ID of the group in the customer's identity provider.
Options
--json JSON
Either inline JSON string or @path/to/file.json with request body.
databricks account iam-v2 resolve-service-principal
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Resolve an external service principal in the Databricks account.
This command resolves a service principal with the given external ID from the customer's identity provider. If the service principal does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this command will return an error.
databricks account iam-v2 resolve-service-principal EXTERNAL_ID [flags]
Arguments
EXTERNAL_ID
Required. The external ID of the service principal in the customer's identity provider.
Options
--json JSON
Either inline JSON string or @path/to/file.json with request body.
databricks account iam-v2 resolve-user
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
Resolve an external user in the Databricks account.
This command resolves a user with the given external ID from the customer's identity provider. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this command will return an error.
databricks account iam-v2 resolve-user EXTERNAL_ID [flags]
Arguments
EXTERNAL_ID
Required. The external ID of the user in the customer's identity provider.
Options
--json JSON
Either inline JSON string or @path/to/file.json with request body.
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