com.databricks.sdk.service.oauth2

Class ServicePrincipalSecretsProxyAPI

java.lang.Object

com.databricks.sdk.service.oauth2.ServicePrincipalSecretsProxyAPI

@Generated
public class ServicePrincipalSecretsProxyAPI
extends Object

These APIs enable administrators to manage service principal secrets at the workspace level. To use these APIs, the service principal must be first added to the current workspace.

You can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals].

In addition, the generated secrets can be used to configure the Databricks Terraform Providerto authenticate with the service principal. For more information, see [Databricks Terraform Provider].

[Authentication using OAuth tokens for service principals]: https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform Provider]: https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal

Constructor Summary

Constructors

Constructor and Description
ServicePrincipalSecretsProxyAPI(ApiClient apiClient) Regular-use constructor
ServicePrincipalSecretsProxyAPI(ServicePrincipalSecretsProxyService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreateServicePrincipalSecretResponse	create(CreateServicePrincipalSecretRequest request) Create a secret for the given service principal.
void	delete(DeleteServicePrincipalSecretRequest request) Delete a secret from the given service principal.
void	delete(String servicePrincipalId, String secretId)
ServicePrincipalSecretsProxyService	impl()
Iterable<SecretInfo>	list(ListServicePrincipalSecretsRequest request) List all secrets associated with the given service principal.
Iterable<SecretInfo>	list(String servicePrincipalId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePrincipalSecretsProxyAPI

public ServicePrincipalSecretsProxyAPI(ApiClient apiClient)

Regular-use constructor

ServicePrincipalSecretsProxyAPI

public ServicePrincipalSecretsProxyAPI(ServicePrincipalSecretsProxyService mock)

Constructor for mocks

Method Detail

create

public CreateServicePrincipalSecretResponse create(CreateServicePrincipalSecretRequest request)

Create a secret for the given service principal.

delete

public void delete(String servicePrincipalId,
                   String secretId)

delete

public void delete(DeleteServicePrincipalSecretRequest request)

Delete a secret from the given service principal.

list

public Iterable<SecretInfo> list(String servicePrincipalId)

list

public Iterable<SecretInfo> list(ListServicePrincipalSecretsRequest request)

List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values.

impl

public ServicePrincipalSecretsProxyService impl()