Workspace Access

View as Markdown

The details of a principal's access to a workspace.

Get workspace access details for a principalGET /api/2.0/identity/workspace-access-details/{principal_id}

WorkspaceAccessDetail object

The details of a principal's access to a workspace.

principal_idint64BetaOutput only

The internal ID of the principal (user/sp/group) in <Databricks>.

workspace_idint64BetaOutput only

The workspace ID where the principal has access.

account_idstringBetaOutput only

The account ID parent of the workspace where the principal has access.

principal_typestringBetaOutput only

The type of the principal (user/sp/group).

Values:

• PRINCIPAL_TYPE_UNSPECIFIED
• USER
• SERVICE_PRINCIPAL
• GROUP

access_typestringBetaOutput only

The type of access the principal has to the workspace.

Values:

• ACCESS_TYPE_UNSPECIFIED
• DIRECT
• INDIRECT

statusstringBeta

The activity status of the principal in the workspace. Not applicable for groups at the moment.

Values:

• STATE_UNSPECIFIED
• ACTIVE
• INACTIVE

permissionsarray of stringBeta

The permissions granted to the principal in the workspace.

Values:

• WORKSPACE_PERMISSION_UNSPECIFIED
• USER_PERMISSION
• ADMIN_PERMISSION

View as Markdown

The WorkspaceAccessDetail object

{
  "principal_id": 0,
  "workspace_id": 0,
  "account_id": "string",
  "principal_type": "USER",
  "access_type": "DIRECT",
  "status": "ACTIVE",
  "permissions": [
    "USER_PERMISSION"
  ]
}

Get workspace access details for a principal Beta

GET /api/2.0/identity/workspace-access-details/{principal_id}

Returns the access details for a principal in the current workspace. Allows for checking access details for any provisioned principal (user, service principal, or group) in the current workspace.

• Provisioned principal here refers to one that has been synced into <Databricks> from the customer's IdP or added explicitly to <Databricks> via SCIM/UI. Allows for passing in a "view" parameter to control what fields are returned (BASIC by default or FULL).

API scopes: identity

Parameters

principal_idint64Requiredpath

Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.

viewstringquery

Controls what fields are returned.

Default: BASIC

Values:

• WORKSPACE_ACCESS_DETAIL_VIEW_UNSPECIFIED
• BASIC
• FULL

Response

Returns the WorkspaceAccessDetail object.

View as Markdown

Response

{
  "principal_id": 0,
  "workspace_id": 0,
  "account_id": "string",
  "principal_type": "USER",
  "access_type": "DIRECT",
  "status": "ACTIVE",
  "permissions": [
    "USER_PERMISSION"
  ]
}