workspace_access_details

Creates, updates, deletes, gets or lists a workspace_access_details resource.

Overview

Name	workspace_access_details
Type	Resource
Id	databricks_workspace.iamv2.workspace_access_details

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
account_id	string	The account ID parent of the workspace where the principal has access.
principal_id	integer	The internal ID of the principal (user/sp/group) in Databricks.
workspace_id	integer	The workspace ID where the principal has access.
access_type	string	The type of access the principal has to the workspace. (DIRECT, INDIRECT)
permissions	array	The permissions granted to the principal in the workspace.
principal_type	string	The type of the principal (user/sp/group). (GROUP, SERVICE_PRINCIPAL, USER)
status	string	The activity status of the principal in the workspace. Not applicable for groups at the moment. (ACTIVE, INACTIVE)

list

Name	Datatype	Description
account_id	string	The account ID parent of the workspace where the principal has access.
principal_id	integer	The internal ID of the principal (user/sp/group) in Databricks.
workspace_id	integer	The workspace ID where the principal has access.
access_type	string	The type of access the principal has to the workspace. (DIRECT, INDIRECT)
permissions	array	The permissions granted to the principal in the workspace.
principal_type	string	The type of the principal (user/sp/group). (GROUP, SERVICE_PRINCIPAL, USER)
status	string	The activity status of the principal in the workspace. Not applicable for groups at the moment. (ACTIVE, INACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	principal_id, deployment_name	view	Returns the access details for a principal in the current workspace. Allows for checking access
list	select	deployment_name	page_size, page_token	Lists the access details of every provisioned principal (user, service principal, or group) with

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
principal_id	integer	Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.
page_size	integer	The maximum number of workspace access details to return. The service may return fewer than this value.
page_token	string	A page token, received from a previous ListWorkspaceAccessDetails call. Provide this to retrieve the subsequent page.
view	string	Controls what fields are returned.

SELECT examples

get

Returns the access details for a principal in the current workspace. Allows for checking access

SELECT
account_id,
principal_id,
workspace_id,
access_type,
permissions,
principal_type,
status
FROM databricks_workspace.iamv2.workspace_access_details
WHERE principal_id = '{{ principal_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND view = '{{ view }}'
;

list

Lists the access details of every provisioned principal (user, service principal, or group) with

SELECT
account_id,
principal_id,
workspace_id,
access_type,
permissions,
principal_type,
status
FROM databricks_workspace.iamv2.workspace_access_details
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;