databricks-sdk 0.28.0__py3-none-any.whl → 0.30.0__py3-none-any.whl

databricks/sdk/service/iam.py

@@ -132,16 +132,16 @@ class DeleteResponse:
 
 
 @dataclass
-class DeleteWorkspaceAssignments:
+class DeleteWorkspacePermissionAssignmentResponse:
 
     def as_dict(self) -> dict:
-        """Serializes the DeleteWorkspaceAssignments into a dictionary suitable for use as a JSON request body."""
+        """Serializes the DeleteWorkspacePermissionAssignmentResponse into a dictionary suitable for use as a JSON request body."""
         body = {}
         return body
 
     @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> DeleteWorkspaceAssignments:
-        """Deserializes the DeleteWorkspaceAssignments from a dictionary."""
+    def from_dict(cls, d: Dict[str, any]) -> DeleteWorkspacePermissionAssignmentResponse:
+        """Deserializes the DeleteWorkspacePermissionAssignmentResponse from a dictionary."""
         return cls()
 
 
@@ -406,6 +406,56 @@ class ListUsersResponse:
                    total_results=d.get('totalResults', None))
 
 
+@dataclass
+class MigratePermissionsRequest:
+    workspace_id: int
+    """WorkspaceId of the associated workspace where the permission migration will occur."""
+
+    from_workspace_group_name: str
+    """The name of the workspace group that permissions will be migrated from."""
+
+    to_account_group_name: str
+    """The name of the account group that permissions will be migrated to."""
+
+    size: Optional[int] = None
+    """The maximum number of permissions that will be migrated."""
+
+    def as_dict(self) -> dict:
+        """Serializes the MigratePermissionsRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.from_workspace_group_name is not None:
+            body['from_workspace_group_name'] = self.from_workspace_group_name
+        if self.size is not None: body['size'] = self.size
+        if self.to_account_group_name is not None: body['to_account_group_name'] = self.to_account_group_name
+        if self.workspace_id is not None: body['workspace_id'] = self.workspace_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MigratePermissionsRequest:
+        """Deserializes the MigratePermissionsRequest from a dictionary."""
+        return cls(from_workspace_group_name=d.get('from_workspace_group_name', None),
+                   size=d.get('size', None),
+                   to_account_group_name=d.get('to_account_group_name', None),
+                   workspace_id=d.get('workspace_id', None))
+
+
+@dataclass
+class MigratePermissionsResponse:
+    permissions_migrated: Optional[int] = None
+    """Number of permissions migrated."""
+
+    def as_dict(self) -> dict:
+        """Serializes the MigratePermissionsResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.permissions_migrated is not None: body['permissions_migrated'] = self.permissions_migrated
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MigratePermissionsResponse:
+        """Deserializes the MigratePermissionsResponse from a dictionary."""
+        return cls(permissions_migrated=d.get('permissions_migrated', None))
+
+
 @dataclass
 class Name:
     family_name: Optional[str] = None
@@ -723,6 +773,9 @@ class Permission:
 
 @dataclass
 class PermissionAssignment:
+    """The output format for existing workspace PermissionAssignment records, which contains some info
+    for user consumption."""
+
     error: Optional[str] = None
     """Error response associated with a workspace permission assignment, if any."""
 
@@ -777,6 +830,7 @@ class PermissionLevel(Enum):
     CAN_MANAGE_PRODUCTION_VERSIONS = 'CAN_MANAGE_PRODUCTION_VERSIONS'
     CAN_MANAGE_RUN = 'CAN_MANAGE_RUN'
     CAN_MANAGE_STAGING_VERSIONS = 'CAN_MANAGE_STAGING_VERSIONS'
+    CAN_MONITOR = 'CAN_MONITOR'
     CAN_QUERY = 'CAN_QUERY'
     CAN_READ = 'CAN_READ'
     CAN_RESTART = 'CAN_RESTART'
@@ -787,57 +841,6 @@ class PermissionLevel(Enum):
     IS_OWNER = 'IS_OWNER'
 
 
-@dataclass
-class PermissionMigrationRequest:
-    workspace_id: int
-    """WorkspaceId of the associated workspace where the permission migration will occur. Both
-    workspace group and account group must be in this workspace."""
-
-    from_workspace_group_name: str
-    """The name of the workspace group that permissions will be migrated from."""
-
-    to_account_group_name: str
-    """The name of the account group that permissions will be migrated to."""
-
-    size: Optional[int] = None
-    """The maximum number of permissions that will be migrated."""
-
-    def as_dict(self) -> dict:
-        """Serializes the PermissionMigrationRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.from_workspace_group_name is not None:
-            body['from_workspace_group_name'] = self.from_workspace_group_name
-        if self.size is not None: body['size'] = self.size
-        if self.to_account_group_name is not None: body['to_account_group_name'] = self.to_account_group_name
-        if self.workspace_id is not None: body['workspace_id'] = self.workspace_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> PermissionMigrationRequest:
-        """Deserializes the PermissionMigrationRequest from a dictionary."""
-        return cls(from_workspace_group_name=d.get('from_workspace_group_name', None),
-                   size=d.get('size', None),
-                   to_account_group_name=d.get('to_account_group_name', None),
-                   workspace_id=d.get('workspace_id', None))
-
-
-@dataclass
-class PermissionMigrationResponse:
-    permissions_migrated: Optional[int] = None
-    """Number of permissions migrated."""
-
-    def as_dict(self) -> dict:
-        """Serializes the PermissionMigrationResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.permissions_migrated is not None: body['permissions_migrated'] = self.permissions_migrated
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> PermissionMigrationResponse:
-        """Deserializes the PermissionMigrationResponse from a dictionary."""
-        return cls(permissions_migrated=d.get('permissions_migrated', None))
-
-
 @dataclass
 class PermissionOutput:
     description: Optional[str] = None
@@ -888,9 +891,9 @@ class PermissionsRequest:
     """The id of the request object."""
 
     request_object_type: Optional[str] = None
-    """The type of the request object. Can be one of the following: authorization, clusters,
-    cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-    registered-models, repos, serving-endpoints, or warehouses."""
+    """The type of the request object. Can be one of the following: alerts, authorization, clusters,
+    cluster-policies, dbsql-dashboards, directories, experiments, files, instance-pools, jobs,
+    notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses."""
 
     def as_dict(self) -> dict:
         """Serializes the PermissionsRequest into a dictionary suitable for use as a JSON request body."""
@@ -911,6 +914,8 @@ class PermissionsRequest:
 
 @dataclass
 class PrincipalOutput:
+    """Information about the principal assigned to the workspace."""
+
     display_name: Optional[str] = None
     """The display name of the principal."""
 
@@ -1134,16 +1139,18 @@ class UpdateRuleSetRequest:
 
 @dataclass
 class UpdateWorkspaceAssignments:
-    permissions: List[WorkspacePermission]
-    """Array of permissions assignments to update on the workspace. Note that excluding this field will
-    have the same effect as providing an empty list which will result in the deletion of all
+    permissions: Optional[List[WorkspacePermission]] = None
+    """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."""
 
     principal_id: Optional[int] = None
     """The ID of the user, service principal, or group."""
 
     workspace_id: Optional[int] = None
-    """The workspace ID."""
+    """The workspace ID for the account."""
 
     def as_dict(self) -> dict:
         """Serializes the UpdateWorkspaceAssignments into a dictionary suitable for use as a JSON request body."""
@@ -2495,7 +2502,7 @@ class GroupsAPI:
 
 
 class PermissionMigrationAPI:
-    """This spec contains undocumented permission migration APIs used in https://github.com/databrickslabs/ucx."""
+    """APIs for migrating acl permissions, used only by the ucx tool: https://github.com/databrickslabs/ucx"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -2505,14 +2512,11 @@ class PermissionMigrationAPI:
                             from_workspace_group_name: str,
                             to_account_group_name: str,
                             *,
-                            size: Optional[int] = None) -> PermissionMigrationResponse:
+                            size: Optional[int] = None) -> MigratePermissionsResponse:
         """Migrate Permissions.
         
-        Migrate a batch of permissions from a workspace local group to an account group.
-        
         :param workspace_id: int
-          WorkspaceId of the associated workspace where the permission migration will occur. Both workspace
-          group and account group must be in this workspace.
+          WorkspaceId of the associated workspace where the permission migration will occur.
         :param from_workspace_group_name: str
           The name of the workspace group that permissions will be migrated from.
         :param to_account_group_name: str
@@ -2520,7 +2524,7 @@ class PermissionMigrationAPI:
         :param size: int (optional)
           The maximum number of permissions that will be migrated.
         
-        :returns: :class:`PermissionMigrationResponse`
+        :returns: :class:`MigratePermissionsResponse`
         """
         body = {}
         if from_workspace_group_name is not None:
@@ -2531,13 +2535,15 @@ class PermissionMigrationAPI:
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 
         res = self._api.do('POST', '/api/2.0/permissionmigration', body=body, headers=headers)
-        return PermissionMigrationResponse.from_dict(res)
+        return MigratePermissionsResponse.from_dict(res)
 
 
 class PermissionsAPI:
     """Permissions API are used to create read, write, edit, update and manage access for various users on
     different objects and endpoints.
     
+    * **[Apps permissions](:service:apps)** — Manage which users can manage or use apps.
+    
     * **[Cluster permissions](:service:clusters)** — Manage which users can manage, restart, or attach to
     clusters.
     
@@ -2573,7 +2579,7 @@ class PermissionsAPI:
     * **[Token permissions](:service:tokenmanagement)** — Manage which users can create or use tokens.
     
     * **[Workspace object permissions](:service:workspace)** — Manage which users can read, run, edit, or
-    manage directories, files, and notebooks.
+    manage alerts, dbsql-dashboards, directories, files, notebooks and queries.
     
     For the mapping of the required permissions for specific actions or abilities and other important
     information, see [Access Control].
@@ -2593,9 +2599,9 @@ class PermissionsAPI:
         object.
         
         :param request_object_type: str
-          The type of the request object. Can be one of the following: authorization, clusters,
-          cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or warehouses.
+          The type of the request object. Can be one of the following: alerts, authorization, clusters,
+          cluster-policies, dbsql-dashboards, directories, experiments, files, instance-pools, jobs,
+          notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         
@@ -2641,9 +2647,9 @@ class PermissionsAPI:
         object.
         
         :param request_object_type: str
-          The type of the request object. Can be one of the following: authorization, clusters,
-          cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or warehouses.
+          The type of the request object. Can be one of the following: alerts, authorization, clusters,
+          cluster-policies, dbsql-dashboards, directories, experiments, files, instance-pools, jobs,
+          notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         :param access_control_list: List[:class:`AccessControlRequest`] (optional)
@@ -2672,9 +2678,9 @@ class PermissionsAPI:
         root object.
         
         :param request_object_type: str
-          The type of the request object. Can be one of the following: authorization, clusters,
-          cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or warehouses.
+          The type of the request object. Can be one of the following: alerts, authorization, clusters,
+          cluster-policies, dbsql-dashboards, directories, experiments, files, instance-pools, jobs,
+          notebooks, pipelines, queries, registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         :param access_control_list: List[:class:`AccessControlRequest`] (optional)
@@ -3313,7 +3319,7 @@ class WorkspaceAssignmentAPI:
         principal.
         
         :param workspace_id: int
-          The workspace ID.
+          The workspace ID for the account.
         :param principal_id: int
           The ID of the user, service principal, or group.
         
@@ -3366,21 +3372,26 @@ class WorkspaceAssignmentAPI:
         parsed = PermissionAssignments.from_dict(json).permission_assignments
         return parsed if parsed is not None else []
 
-    def update(self, workspace_id: int, principal_id: int,
-               permissions: List[WorkspacePermission]) -> PermissionAssignment:
+    def update(self,
+               workspace_id: int,
+               principal_id: int,
+               *,
+               permissions: Optional[List[WorkspacePermission]] = None) -> PermissionAssignment:
         """Create or update permissions assignment.
         
         Creates or updates the workspace permissions assignment in a given account and workspace for the
         specified principal.
         
         :param workspace_id: int
-          The workspace ID.
+          The workspace ID for the account.
         :param principal_id: int
           The ID of the user, service principal, or group.
-        :param permissions: List[:class:`WorkspacePermission`]
-          Array of permissions assignments to update on the workspace. Note that excluding this field will
-          have the same effect as providing an empty list which will result in the deletion of all permissions
-          for the principal.
+        :param permissions: List[:class:`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: :class:`PermissionAssignment`
         """