a.workspace_assignment: Workspace Assignment

class databricks.sdk.service.iam.WorkspaceAssignmentAPI

The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account.

delete(workspace_id: int, principal_id: int)

Delete permissions assignment.

Deletes the workspace permissions assignment in a given account and workspace for the specified principal.

Parameters:

• workspace_id – int The workspace ID for the account.

• principal_id – int The ID of the user, service principal, or group.

get(workspace_id: int) → WorkspacePermissions

List workspace permissions.

Get an array of workspace permissions for the specified account and workspace.

Parameters:

workspace_id – int The workspace ID.

Returns:

WorkspacePermissions

list(workspace_id: int) → Iterator[PermissionAssignment]

Usage:

import os

from databricks.sdk import AccountClient

a = AccountClient()

workspace_id = os.environ["TEST_WORKSPACE_ID"]

all = a.workspace_assignment.list(list=workspace_id)

Get permission assignments.

Get the permission assignments for the specified Databricks account and Databricks workspace.

Parameters:

workspace_id – int The workspace ID for the account.

Returns:

Iterator over PermissionAssignment

update(workspace_id: int, principal_id: int [, permissions: Optional[List[WorkspacePermission]]]) → PermissionAssignment

Usage:

import os
import time

from databricks.sdk import AccountClient
from databricks.sdk.service import iam

a = AccountClient()

spn = a.service_principals.create(display_name=f"sdk-{time.time_ns()}")

spn_id = spn.id

workspace_id = os.environ["DUMMY_WORKSPACE_ID"]

_ = a.workspace_assignment.update(
    workspace_id=workspace_id,
    principal_id=spn_id,
    permissions=[iam.WorkspacePermission.USER],
)

Create or update permissions assignment.

Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal.

Parameters:

• workspace_id – int The workspace ID.

• principal_id – int The ID of the user, service principal, or group.

• permissions – List[WorkspacePermission] (optional) Array of permissions assignments to update on the workspace. Valid values are “USER” and “ADMIN” (case-sensitive). If both “USER” and “ADMIN” are provided, “ADMIN” takes precedence. Other values will be ignored. Note that excluding this field, or providing unsupported values, will have the same effect as providing an empty list, which will result in the deletion of all permissions for the principal.

Returns:

PermissionAssignment