com.databricks.sdk.service.workspace

Class SecretsAPI

java.lang.Object

com.databricks.sdk.service.workspace.SecretsAPI

Direct Known Subclasses:

SecretsExt

@Generated
public class SecretsAPI
extends Object

The Secrets API allows you to manage secrets, secret scopes, and access permissions.

Sometimes accessing data requires that you authenticate to external data sources through JDBC. Instead of directly entering your credentials into a notebook, use Databricks secrets to store your credentials and reference them in notebooks and jobs.

Administrators, secret creators, and users granted permission can read Databricks secrets. While Databricks makes an effort to redact secret values that might be displayed in notebooks, it is not possible to prevent such users from reading secrets.

Constructor Summary

Constructors

Constructor and Description
SecretsAPI(ApiClient apiClient) Regular-use constructor
SecretsAPI(SecretsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	createScope(CreateScope request) Create a new secret scope.
void	createScope(String scope)
void	deleteAcl(DeleteAcl request) Delete an ACL.
void	deleteAcl(String scope, String principal)
void	deleteScope(DeleteScope request) Delete a secret scope.
void	deleteScope(String scope)
void	deleteSecret(DeleteSecret request) Delete a secret.
void	deleteSecret(String scope, String key)
AclItem	getAcl(GetAclRequest request) Get secret ACL details.
AclItem	getAcl(String scope, String principal)
GetSecretResponse	getSecret(GetSecretRequest request) Get a secret.
GetSecretResponse	getSecret(String scope, String key)
SecretsService	impl()
Iterable<AclItem>	listAcls(ListAclsRequest request) Lists ACLs.
Iterable<AclItem>	listAcls(String scope)
Iterable<SecretScope>	listScopes() List all scopes.
Iterable<SecretMetadata>	listSecrets(ListSecretsRequest request) List secret keys.
Iterable<SecretMetadata>	listSecrets(String scope)
void	putAcl(PutAcl request) Create/update an ACL.
void	putAcl(String scope, String principal, AclPermission permission)
void	putSecret(PutSecret request) Add a secret.
void	putSecret(String scope, String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretsAPI

public SecretsAPI(ApiClient apiClient)

Regular-use constructor

SecretsAPI

public SecretsAPI(SecretsService mock)

Constructor for mocks

Method Detail

createScope

public void createScope(String scope)

createScope

public void createScope(CreateScope request)

Create a new secret scope.

The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.

deleteAcl

public void deleteAcl(String scope,
                      String principal)

deleteAcl

public void deleteAcl(DeleteAcl request)

Delete an ACL.

Deletes the given ACL on the given scope.

Users must have the `MANAGE` permission to invoke this API. Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope, principal, or ACL exists. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

deleteScope

public void deleteScope(String scope)

deleteScope

public void deleteScope(DeleteScope request)

Delete a secret scope.

Deletes a secret scope.

Throws `RESOURCE_DOES_NOT_EXIST` if the scope does not exist. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

deleteSecret

public void deleteSecret(String scope,
                         String key)

deleteSecret

public void deleteSecret(DeleteSecret request)

Delete a secret.

Deletes the secret stored in this secret scope. You must have `WRITE` or `MANAGE` permission on the secret scope.

Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope or secret exists. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

getAcl

public AclItem getAcl(String scope,
                      String principal)

getAcl

public AclItem getAcl(GetAclRequest request)

Get secret ACL details.

Gets the details about the given ACL, such as the group and permission. Users must have the `MANAGE` permission to invoke this API.

Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

getSecret

public GetSecretResponse getSecret(String scope,
                                   String key)

getSecret

public GetSecretResponse getSecret(GetSecretRequest request)

Get a secret.

Gets the bytes representation of a secret value for the specified scope and key.

Users need the READ permission to make this call.

Note that the secret value returned is in bytes. The interpretation of the bytes is determined by the caller in DBUtils and the type the data is decoded into.

Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists.

listAcls

public Iterable<AclItem> listAcls(String scope)

listAcls

public Iterable<AclItem> listAcls(ListAclsRequest request)

Lists ACLs.

List the ACLs for a given secret scope. Users must have the `MANAGE` permission to invoke this API.

Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

listScopes

public Iterable<SecretScope> listScopes()

List all scopes.

Lists all secret scopes available in the workspace.

Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

listSecrets

public Iterable<SecretMetadata> listSecrets(String scope)

listSecrets

public Iterable<SecretMetadata> listSecrets(ListSecretsRequest request)

List secret keys.

Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data cannot be retrieved using this API. Users need the READ permission to make this call.

The lastUpdatedTimestamp returned is in milliseconds since epoch. Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

putAcl

public void putAcl(String scope,
                   String principal,
                   AclPermission permission)

putAcl

public void putAcl(PutAcl request)

Create/update an ACL.

Creates or overwrites the Access Control List (ACL) associated with the given principal (user or group) on the specified scope point.

In general, a user or group will use the most powerful permission available to them, and permissions are ordered as follows:

* `MANAGE` - Allowed to change ACLs, and read and write to this secret scope. * `WRITE` - Allowed to read and write to this secret scope. * `READ` - Allowed to read this secret scope and list what secrets are available.

Note that in general, secret values can only be read from within a command on a cluster (for example, through a notebook). There is no API to read the actual secret value material outside of a cluster. However, the user's permission will be applied based on who is executing the command, and they must have at least READ permission.

Users must have the `MANAGE` permission to invoke this API.

The principal is a user or group name corresponding to an existing Databricks principal to be granted or revoked access.

Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `RESOURCE_ALREADY_EXISTS` if a permission for the principal already exists. Throws `INVALID_PARAMETER_VALUE` if the permission or principal is invalid. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

putSecret

public void putSecret(String scope,
                      String key)

putSecret

public void putSecret(PutSecret request)

Add a secret.

Inserts a secret under the provided scope with the given name. If a secret already exists with the same name, this command overwrites the existing secret's value. The server encrypts the secret using the secret scope's encryption settings before storing it.

You must have `WRITE` or `MANAGE` permission on the secret scope. The secret key must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters. The maximum allowed secret value size is 128 KB. The maximum number of secrets in a given scope is 1000.

The input fields "string_value" or "bytes_value" specify the type of the secret, which will determine the value returned when the secret value is requested. Exactly one must be specified.

Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws `RESOURCE_LIMIT_EXCEEDED` if maximum number of secrets in scope is exceeded. Throws `INVALID_PARAMETER_VALUE` if the key name or value length is invalid. Throws `PERMISSION_DENIED` if the user does not have permission to make this API call.

impl

public SecretsService impl()