com.databricks.sdk.service.iam

Class PermissionsAPI

java.lang.Object

com.databricks.sdk.service.iam.PermissionsAPI

@Generated
public class PermissionsAPI
extends Object

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. * **[Cluster policy permissions](:service:clusterpolicies)** — Manage which users can use cluster policies. * **[Delta Live Tables pipeline permissions](:service:pipelines)** — Manage which users can view, manage, run, cancel, or own a Delta Live Tables pipeline. * **[Job permissions](:service:jobs)** — Manage which users can view, manage, trigger, cancel, or own a job. * **[MLflow experiment permissions](:service:experiments)** — Manage which users can read, edit, or manage MLflow experiments. * **[MLflow registered model permissions](:service:modelregistry)** — Manage which users can read, edit, or manage MLflow registered models. * **[Instance Pool permissions](:service:instancepools)** — Manage which users can manage or attach to pools. * **[Repo permissions](repos)** — Manage which users can read, run, edit, or manage a repo. * **[Serving endpoint permissions](:service:servingendpoints)** — Manage which users can view, query, or manage a serving endpoint. * **[SQL warehouse permissions](:service:warehouses)** — Manage which users can use or manage SQL warehouses. * **[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 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]. Note that to manage access control on service principals, use **[Account Access Control Proxy](:service:accountaccesscontrolproxy)**.

[Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html

Constructor Summary

Constructors

Constructor and Description
PermissionsAPI(ApiClient apiClient) Regular-use constructor
PermissionsAPI(PermissionsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ObjectPermissions	get(GetPermissionRequest request) Gets the permissions of an object.
ObjectPermissions	get(String requestObjectType, String requestObjectId)
GetPermissionLevelsResponse	getPermissionLevels(GetPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetPermissionLevelsResponse	getPermissionLevels(String requestObjectType, String requestObjectId)
PermissionsService	impl()
ObjectPermissions	set(SetObjectPermissions request) Sets permissions on an object, replacing existing permissions if they exist.
ObjectPermissions	update(UpdateObjectPermissions request) Updates the permissions on an object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PermissionsAPI

public PermissionsAPI(ApiClient apiClient)

Regular-use constructor

PermissionsAPI

public PermissionsAPI(PermissionsService mock)

Constructor for mocks

Method Detail

get

public ObjectPermissions get(String requestObjectType,
                             String requestObjectId)

get

public ObjectPermissions get(GetPermissionRequest request)

Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object.

getPermissionLevels

public GetPermissionLevelsResponse getPermissionLevels(String requestObjectType,
                                                       String requestObjectId)

getPermissionLevels

public GetPermissionLevelsResponse getPermissionLevels(GetPermissionLevelsRequest request)

Gets the permission levels that a user can have on an object.

set

public ObjectPermissions set(SetObjectPermissions request)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object.

update

public ObjectPermissions update(UpdateObjectPermissions request)

Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object.

impl

public PermissionsService impl()