com.databricks.sdk.service.catalog

Class CredentialsAPI

java.lang.Object

com.databricks.sdk.service.catalog.CredentialsAPI

@Generated
public class CredentialsAPI
extends Object

A credential represents an authentication and authorization mechanism for accessing services on your cloud tenant. Each credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential.

To create credentials, you must be a Databricks account admin or have the `CREATE SERVICE CREDENTIAL` privilege. The user who creates the credential can delegate ownership to another user or group to manage permissions on it.

Constructor Summary

Constructors

Constructor and Description
CredentialsAPI(ApiClient apiClient) Regular-use constructor
CredentialsAPI(CredentialsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CredentialInfo	createCredential(CreateCredentialRequest request) Create a credential.
CredentialInfo	createCredential(String name)
void	deleteCredential(DeleteCredentialRequest request) Delete a credential.
void	deleteCredential(String nameArg)
TemporaryCredentials	generateTemporaryServiceCredential(GenerateTemporaryServiceCredentialRequest request) Generate a temporary service credential.
TemporaryCredentials	generateTemporaryServiceCredential(String credentialName)
CredentialInfo	getCredential(GetCredentialRequest request) Get a credential.
CredentialInfo	getCredential(String nameArg)
CredentialsService	impl()
Iterable<CredentialInfo>	listCredentials(ListCredentialsRequest request) List credentials.
CredentialInfo	updateCredential(String nameArg)
CredentialInfo	updateCredential(UpdateCredentialRequest request) Update a credential.
ValidateCredentialResponse	validateCredential(ValidateCredentialRequest request) Validate a credential.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsAPI

public CredentialsAPI(ApiClient apiClient)

Regular-use constructor

CredentialsAPI

public CredentialsAPI(CredentialsService mock)

Constructor for mocks

Method Detail

createCredential

public CredentialInfo createCredential(String name)

createCredential

public CredentialInfo createCredential(CreateCredentialRequest request)

Create a credential.

Creates a new credential. The type of credential to be created is determined by the **purpose** field, which should be either **SERVICE** or **STORAGE**.

The caller must be a metastore admin or have the metastore privilege **CREATE_STORAGE_CREDENTIAL** for storage credentials, or **CREATE_SERVICE_CREDENTIAL** for service credentials.

deleteCredential

public void deleteCredential(String nameArg)

deleteCredential

public void deleteCredential(DeleteCredentialRequest request)

Delete a credential.

Deletes a service or storage credential from the metastore. The caller must be an owner of the credential.

generateTemporaryServiceCredential

public TemporaryCredentials generateTemporaryServiceCredential(String credentialName)

generateTemporaryServiceCredential

public TemporaryCredentials generateTemporaryServiceCredential(GenerateTemporaryServiceCredentialRequest request)

Generate a temporary service credential.

Returns a set of temporary credentials generated using the specified service credential. The caller must be a metastore admin or have the metastore privilege **ACCESS** on the service credential.

getCredential

public CredentialInfo getCredential(String nameArg)

getCredential

public CredentialInfo getCredential(GetCredentialRequest request)

Get a credential.

Gets a service or storage credential from the metastore. The caller must be a metastore admin, the owner of the credential, or have any permission on the credential.

listCredentials

public Iterable<CredentialInfo> listCredentials(ListCredentialsRequest request)

List credentials.

Gets an array of credentials (as __CredentialInfo__ objects).

The array is limited to only the credentials that the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array.

updateCredential

public CredentialInfo updateCredential(String nameArg)

updateCredential

public CredentialInfo updateCredential(UpdateCredentialRequest request)

Update a credential.

Updates a service or storage credential on the metastore.

The caller must be the owner of the credential or a metastore admin or have the `MANAGE` permission. If the caller is a metastore admin, only the __owner__ field can be changed.

validateCredential

public ValidateCredentialResponse validateCredential(ValidateCredentialRequest request)

Validate a credential.

Validates a credential.

For service credentials (purpose is **SERVICE**), either the __credential_name__ or the cloud-specific credential must be provided.

For storage credentials (purpose is **STORAGE**), at least one of __external_location_name__ and __url__ need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__ will be used for validation, and __external_location_name__ will be ignored when checking overlapping urls. Either the __credential_name__ or the cloud-specific credential must be provided.

The caller must be a metastore admin or the credential owner or have the required permission on the metastore and the credential (e.g., **CREATE_EXTERNAL_LOCATION** when purpose is **STORAGE**).

impl

public CredentialsService impl()