Identity and Access Management

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.iamv2 module.

class databricks.sdk.service.iamv2.Entitlement

ALLOW_CLUSTER_CREATE = "ALLOW_CLUSTER_CREATE"

ALLOW_INSTANCE_POOL_CREATE = "ALLOW_INSTANCE_POOL_CREATE"

DATABRICKS_SQL_ACCESS = "DATABRICKS_SQL_ACCESS"

WORKSPACE_ACCESS = "WORKSPACE_ACCESS"

WORKSPACE_ADMIN = "WORKSPACE_ADMIN"

WORKSPACE_CONSUME = "WORKSPACE_CONSUME"

class databricks.sdk.service.iamv2.Group(account_id: str | None = None, external_id: str | None = None, group_name: str | None = None, internal_id: int | None = None)

The details of a Group resource.

account_id: str | None = None

The parent account ID for group in Databricks.

external_id: str | None = None

ExternalId of the group in the customer’s IdP.

group_name: str | None = None

Display name of the group.

internal_id: int | None = None

Internal group ID of the group in Databricks.

as_dict() → dict

Serializes the Group into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Group into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Group

Deserializes the Group from a dictionary.

class databricks.sdk.service.iamv2.ListWorkspaceAssignmentDetailsResponse(next_page_token: str | None = None, workspace_assignment_details: List[WorkspaceAssignmentDetail] | None = None)

Response message for listing workspace assignment details.

next_page_token: str | None = None

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

workspace_assignment_details: List[WorkspaceAssignmentDetail] | None = None

as_dict() → dict

Serializes the ListWorkspaceAssignmentDetailsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListWorkspaceAssignmentDetailsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListWorkspaceAssignmentDetailsResponse

Deserializes the ListWorkspaceAssignmentDetailsResponse from a dictionary.

class databricks.sdk.service.iamv2.PrincipalType

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

GROUP = "GROUP"

SERVICE_PRINCIPAL = "SERVICE_PRINCIPAL"

USER = "USER"

class databricks.sdk.service.iamv2.ResolveGroupResponse(group: 'Optional[Group]' = None)

group: Group | None = None

The group that was resolved.

as_dict() → dict

Serializes the ResolveGroupResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ResolveGroupResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ResolveGroupResponse

Deserializes the ResolveGroupResponse from a dictionary.

class databricks.sdk.service.iamv2.ResolveServicePrincipalResponse(service_principal: 'Optional[ServicePrincipal]' = None)

service_principal: ServicePrincipal | None = None

The service principal that was resolved.

as_dict() → dict

Serializes the ResolveServicePrincipalResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ResolveServicePrincipalResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ResolveServicePrincipalResponse

Deserializes the ResolveServicePrincipalResponse from a dictionary.

class databricks.sdk.service.iamv2.ResolveUserResponse(user: 'Optional[User]' = None)

user: User | None = None

The user that was resolved.

as_dict() → dict

Serializes the ResolveUserResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ResolveUserResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ResolveUserResponse

Deserializes the ResolveUserResponse from a dictionary.

class databricks.sdk.service.iamv2.ServicePrincipal(account_id: str | None = None, account_sp_status: State | None = None, application_id: str | None = None, display_name: str | None = None, external_id: str | None = None, internal_id: int | None = None)

The details of a ServicePrincipal resource.

account_id: str | None = None

The parent account ID for the service principal in Databricks.

account_sp_status: State | None = None

The activity status of a service principal in a Databricks account.

application_id: str | None = None

Application ID of the service principal.

display_name: str | None = None

Display name of the service principal.

external_id: str | None = None

ExternalId of the service principal in the customer’s IdP.

internal_id: int | None = None

Internal service principal ID of the service principal in Databricks.

as_dict() → dict

Serializes the ServicePrincipal into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ServicePrincipal into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ServicePrincipal

Deserializes the ServicePrincipal from a dictionary.

class databricks.sdk.service.iamv2.State

The activity status of a user or service principal in a Databricks account or workspace.

ACTIVE = "ACTIVE"

INACTIVE = "INACTIVE"

class databricks.sdk.service.iamv2.User(account_id: str | None = None, account_user_status: State | None = None, external_id: str | None = None, internal_id: int | None = None, name: UserName | None = None, username: str | None = None)

The details of a User resource.

account_id: str | None = None

The accountId parent of the user in Databricks.

account_user_status: State | None = None

The activity status of a user in a Databricks account.

external_id: str | None = None

ExternalId of the user in the customer’s IdP.

internal_id: int | None = None

Internal userId of the user in Databricks.

name: UserName | None = None

username: str | None = None

Username/email of the user.

as_dict() → dict

Serializes the User into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the User into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → User

Deserializes the User from a dictionary.

class databricks.sdk.service.iamv2.UserName(family_name: 'Optional[str]' = None, given_name: 'Optional[str]' = None)

family_name: str | None = None

given_name: str | None = None

as_dict() → dict

Serializes the UserName into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the UserName into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → UserName

Deserializes the UserName from a dictionary.

class databricks.sdk.service.iamv2.WorkspaceAccessDetail(access_type: WorkspaceAccessDetailAccessType | None = None, account_id: str | None = None, permissions: List[WorkspacePermission] | None = None, principal_id: int | None = None, principal_type: PrincipalType | None = None, status: State | None = None, workspace_id: int | None = None)

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

access_type: WorkspaceAccessDetailAccessType | None = None

account_id: str | None = None

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

permissions: List[WorkspacePermission] | None = None

The permissions granted to the principal in the workspace.

principal_id: int | None = None

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

principal_type: PrincipalType | None = None

status: State | None = None

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

workspace_id: int | None = None

The workspace ID where the principal has access.

as_dict() → dict

Serializes the WorkspaceAccessDetail into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the WorkspaceAccessDetail into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → WorkspaceAccessDetail

Deserializes the WorkspaceAccessDetail from a dictionary.

class databricks.sdk.service.iamv2.WorkspaceAccessDetailAccessType

The type of access the principal has to the workspace.

DIRECT = "DIRECT"

INDIRECT = "INDIRECT"

class databricks.sdk.service.iamv2.WorkspaceAccessDetailView

Controls what fields are returned in the GetWorkspaceAccessDetail response.

BASIC = "BASIC"

FULL = "FULL"

class databricks.sdk.service.iamv2.WorkspaceAssignmentDetail(principal_id: int, account_id: str | None = None, entitlements: List[Entitlement] | None = None, principal_type: PrincipalType | None = None, workspace_id: int | None = None)

The details of a principal’s assignment to a workspace.

principal_id: int

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

account_id: str | None = None

The account ID parent of the workspace where the principal is assigned

entitlements: List[Entitlement] | None = None

principal_type: PrincipalType | None = None

workspace_id: int | None = None

The workspace ID where the principal is assigned

as_dict() → dict

Serializes the WorkspaceAssignmentDetail into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the WorkspaceAssignmentDetail into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → WorkspaceAssignmentDetail

Deserializes the WorkspaceAssignmentDetail from a dictionary.

class databricks.sdk.service.iamv2.WorkspacePermission

The type of permission a principal has to a workspace (admin/user).

ADMIN_PERMISSION = "ADMIN_PERMISSION"

USER_PERMISSION = "USER_PERMISSION"