com.databricks.sdk.service.catalog

Interface SecretsUcService

@Generated
public interface SecretsUcService

A secret is a Unity Catalog securable object that stores sensitive credential data (such as passwords, tokens, and keys) within a three-level namespace (**catalog_name.schema_name.secret_name**).

Secrets can be managed using standard Unity Catalog permissions and are scoped to a schema within a catalog.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
Secret	createSecret(CreateSecretRequest createSecretRequest) Creates a new secret in Unity Catalog.
void	deleteSecret(DeleteSecretRequest deleteSecretRequest) Deletes a secret by its three-level (fully qualified) name.
Secret	getSecret(GetSecretRequest getSecretRequest) Gets a secret by its three-level (fully qualified) name.
ListSecretsResponse	listSecrets(ListSecretsRequest listSecretsRequest) Lists secrets in Unity Catalog.
Secret	updateSecret(UpdateSecretRequest updateSecretRequest) Updates an existing secret in Unity Catalog.

Method Detail

createSecret

Secret createSecret(CreateSecretRequest createSecretRequest)

Creates a new secret in Unity Catalog.

You must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA** privileges on the parent schema and **USE CATALOG** on the parent catalog.

The secret is stored in the specified catalog and schema, and the **value** field contains the sensitive data to be securely stored.

deleteSecret

void deleteSecret(DeleteSecretRequest deleteSecretRequest)

Deletes a secret by its three-level (fully qualified) name.

You must be the owner of the secret or a metastore admin.

getSecret

Secret getSecret(GetSecretRequest getSecretRequest)

Gets a secret by its three-level (fully qualified) name.

You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret.

The secret value isn't returned by default. To retrieve it, you must also have the **READ_SECRET** privilege and set **include_value** to true in the request.

listSecrets

ListSecretsResponse listSecrets(ListSecretsRequest listSecretsRequest)

Lists secrets in Unity Catalog.

You must be a metastore admin, the owner of the secret, or have the **MANAGE** privilege on the secret.

Both **catalog_name** and **schema_name** must be specified together to filter secrets within a specific schema. Results are paginated; use the **page_token** field from the response to retrieve subsequent pages.

updateSecret

Secret updateSecret(UpdateSecretRequest updateSecretRequest)

Updates an existing secret in Unity Catalog.

You must be the owner of the secret or a metastore admin. If you are a metastore admin, only the **owner** field can be changed.

Use the **update_mask** field to specify which fields to update. Supported updatable fields include **value**, **comment**, **owner**, and **expire_time**.