Skip to main content

Permission

View as Markdown

PermissionsResponse object​

The permissions set on an object, with one entry per principal that holds a permission on it.

object_idstring

Path that identifies the object in the access control list, built from the object type and the object id.

Example: /clusters/0123-456789-abcdefg1

object_typestring

Type of the object, as recorded in the access control list. It can differ from the request_object_type path segment, for example a request for clusters returns cluster.

Example: cluster

access_control_listarray of object

Permissions on the object, with one entry per principal. Each entry lists the principal's direct and inherited permission levels.

Show child attributesHide child attributes
user_namestring

Username of the user, which is the user's email address.

group_namestring

Display name of the group.

service_principal_namestring

Application ID of the service principal.

display_namestring

Display name of the user or service principal.

all_permissionsarray of object

Permission levels the principal holds on the object, both granted directly and inherited.

Show child attributesHide child attributes
permission_levelstring

Permission level the principal holds on the object.

Values:

Show 18 possible values
  • CAN_MANAGE
  • CAN_RESTART
  • CAN_ATTACH_TO
  • IS_OWNER
  • CAN_MANAGE_RUN
  • CAN_VIEW
  • CAN_READ
  • CAN_RUN
  • CAN_EDIT
  • CAN_USE
  • CAN_MANAGE_STAGING_VERSIONS
  • CAN_MANAGE_PRODUCTION_VERSIONS
  • CAN_EDIT_METADATA
  • CAN_VIEW_METADATA
  • CAN_BIND
  • CAN_QUERY
  • CAN_MONITOR
  • CAN_CREATE
inheritedboolean

Whether the permission is inherited from a parent object or the root object instead of being granted directly on the object.

inherited_from_objectarray of string

Paths of the objects the permission is inherited from. It is only set when inherited is true.

Example: /clusters/

Get object permissions GA​

GET /api/2.0/permissions/{request_object_type}/{request_object_id}

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

API scopes: access-management

Parameters​

request_object_typestringRequiredpath

The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.

request_object_idstringRequiredpath

The id of the object. It is the id that the object's own API uses, for example the cluster id for clusters, the job id for jobs, and the workspace object id for notebooks and directories. For the authorization object type, use tokens to manage token permissions.

Response​

Returns the PermissionsResponse object.

Set object permissions GA​

PUT /api/2.0/permissions/{request_object_type}/{request_object_id}

Sets permissions on an object, replacing all direct permissions with the ones in the request. Principals that are not in the request lose their direct permissions on the object, and all direct permissions are deleted if none are specified. Objects can inherit permissions from their parent objects or root object.

API scopes: access-management

Parameters​

request_object_typestringRequiredpath

The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.

request_object_idstringRequiredpath

The id of the object. It is the id that the object's own API uses, for example the cluster id for clusters, the job id for jobs, and the workspace object id for notebooks and directories. For the authorization object type, use tokens to manage token permissions.

Request body​

access_control_listarray of object

Permissions to apply to the object, with one entry per principal. Each entry names exactly one principal through user_name, group_name or service_principal_name and the permission_level for that principal.

Show child attributesHide child attributes
user_namestring

Username of the user, which is the user's email address.

group_namestring

Display name of the group.

service_principal_namestring

Application ID of the service principal.

permission_levelstring

Permission level to grant to the principal.

Values:

Show 18 possible values
  • CAN_MANAGE
  • CAN_RESTART
  • CAN_ATTACH_TO
  • IS_OWNER
  • CAN_MANAGE_RUN
  • CAN_VIEW
  • CAN_READ
  • CAN_RUN
  • CAN_EDIT
  • CAN_USE
  • CAN_MANAGE_STAGING_VERSIONS
  • CAN_MANAGE_PRODUCTION_VERSIONS
  • CAN_EDIT_METADATA
  • CAN_VIEW_METADATA
  • CAN_BIND
  • CAN_QUERY
  • CAN_MONITOR
  • CAN_CREATE

Response​

Returns the PermissionsResponse object.

Get object permission levels GA​

GET /api/2.0/permissions/{request_object_type}/{request_object_id}/permissionLevels

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

API scopes: access-management

Parameters​

request_object_typestringRequiredpath

The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.

request_object_idstringRequiredpath

The id of the object. It is the id that the object's own API uses, for example the cluster id for clusters, the job id for jobs, and the workspace object id for notebooks and directories. For the authorization object type, use tokens to manage token permissions.

Response​

permission_levelsarray of object

Permission levels that can be granted on objects of the requested type.

Show child attributesHide child attributes
permission_levelstring

Permission level that can be granted on the object.

Values:

Show 18 possible values
  • CAN_MANAGE
  • CAN_RESTART
  • CAN_ATTACH_TO
  • IS_OWNER
  • CAN_MANAGE_RUN
  • CAN_VIEW
  • CAN_READ
  • CAN_RUN
  • CAN_EDIT
  • CAN_USE
  • CAN_MANAGE_STAGING_VERSIONS
  • CAN_MANAGE_PRODUCTION_VERSIONS
  • CAN_EDIT_METADATA
  • CAN_VIEW_METADATA
  • CAN_BIND
  • CAN_QUERY
  • CAN_MONITOR
  • CAN_CREATE
descriptionstring

Human-readable description of the permission level.

Update object permissions GA​

PATCH /api/2.0/permissions/{request_object_type}/{request_object_id}

Updates the permissions on an object by adding or changing the permissions of the principals in the request. Principals that are not in the request keep their existing permissions. Objects can inherit permissions from their parent objects or root object.

API scopes: access-management

Parameters​

request_object_typestringRequiredpath

The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.

request_object_idstringRequiredpath

The id of the object. It is the id that the object's own API uses, for example the cluster id for clusters, the job id for jobs, and the workspace object id for notebooks and directories. For the authorization object type, use tokens to manage token permissions.

Request body​

access_control_listarray of object

Permissions to apply to the object, with one entry per principal. Each entry names exactly one principal through user_name, group_name or service_principal_name and the permission_level for that principal.

Show child attributesHide child attributes
user_namestring

Username of the user, which is the user's email address.

group_namestring

Display name of the group.

service_principal_namestring

Application ID of the service principal.

permission_levelstring

Permission level to grant to the principal.

Values:

Show 18 possible values
  • CAN_MANAGE
  • CAN_RESTART
  • CAN_ATTACH_TO
  • IS_OWNER
  • CAN_MANAGE_RUN
  • CAN_VIEW
  • CAN_READ
  • CAN_RUN
  • CAN_EDIT
  • CAN_USE
  • CAN_MANAGE_STAGING_VERSIONS
  • CAN_MANAGE_PRODUCTION_VERSIONS
  • CAN_EDIT_METADATA
  • CAN_VIEW_METADATA
  • CAN_BIND
  • CAN_QUERY
  • CAN_MONITOR
  • CAN_CREATE

Response​

Returns the PermissionsResponse object.