Unity Catalog - Grants Update

Unity Catalog - Grants Update

Certified

Update Unity Catalog permissions

Grants and revokes privileges on a securable object. Each change targets one principal and can add and remove privileges in the same call.

yaml
type: io.kestra.plugin.databricks.unitycatalog.grant.Update

Grant SELECT on a schema to a group

yaml
id: databricks_uc_grant_update
namespace: company.team

tasks:
  - id: grant_select
    type: io.kestra.plugin.databricks.unitycatalog.grant.Update
    host: "{{ secret('DATABRICKS_HOST') }}"
    authentication:
      token: "{{ secret('DATABRICKS_TOKEN') }}"
    securableType: SCHEMA
    fullName: main.landing_zone
    changes:
      - principal: data-analysts
        add:
          - USE_SCHEMA
          - SELECT
Properties
Min items1

Permission changes

List of changes to apply.

Definitions
principal*string

Principal

User, group or service principal the change applies to.

addarray
SubTypestring

Privileges to grant

For example SELECT, MODIFY, USE_SCHEMA, READ_VOLUME or ALL_PRIVILEGES.

removearray
SubTypestring

Privileges to revoke

Same values as add.

Securable full name

Full name of the object: catalog, catalog.schema, catalog.schema.table or catalog.schema.volume depending on the securable type.

Securable type

Type of the object the permissions apply to, for example CATALOG, SCHEMA, TABLE, VOLUME, EXTERNAL_LOCATION or STORAGE_CREDENTIAL. Case-insensitive.

Databricks account identifier

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Databricks authentication configuration

This property allows to configure the authentication to Databricks, different properties should be set depending on the type of authentication and the cloud provider. All configuration options can also be set using the standard Databricks environment variables. Check the Databricks authentication guide for more information.

Definitions
authTypestring

Authentication type

azureClientIdstring

Azure client ID

azureClientSecretstring

Azure client secret

azureTenantIdstring

Azure tenant ID

clientIdstring

Client ID

clientSecretstring

Client secret

googleCredentialsstring

Google credentials JSON

googleServiceAccountstring

Google service account email

passwordstring

Password

tokenstring

Databricks personal access token

usernamestring

Username

Databricks configuration file, use this if you don't want to configure each Databricks account properties one by one

Databricks host

SubTypeobject

Privileges granted on the object, grouped by principal