Package com.databricks.sdk.service.oauth2

Class ServicePrincipalSecretsAPI

java.lang.Object

com.databricks.sdk.service.oauth2.ServicePrincipalSecretsAPI

@Generated
public class ServicePrincipalSecretsAPI
extends Object

These APIs enable administrators to manage service principal secrets.

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 Provider to 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	Description
ServicePrincipalSecretsAPI(ApiClient apiClient)	Regular-use constructor
ServicePrincipalSecretsAPI(ServicePrincipalSecretsService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
CreateServicePrincipalSecretResponse	create(long servicePrincipalId)
CreateServicePrincipalSecretResponse	create(CreateServicePrincipalSecretRequest request)	Create service principal secret.
void	delete(long servicePrincipalId, String secretId)
void	delete(DeleteServicePrincipalSecretRequest request)	Delete service principal secret.
ServicePrincipalSecretsService	impl()
Iterable<SecretInfo>	list(long servicePrincipalId)
Iterable<SecretInfo>	list(ListServicePrincipalSecretsRequest request)	List service principal secrets.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePrincipalSecretsAPI

public ServicePrincipalSecretsAPI(ApiClient apiClient)

Regular-use constructor

ServicePrincipalSecretsAPI

public ServicePrincipalSecretsAPI(ServicePrincipalSecretsService mock)

Constructor for mocks

Method Detail

create

public CreateServicePrincipalSecretResponse create(long servicePrincipalId)

create

public CreateServicePrincipalSecretResponse create(CreateServicePrincipalSecretRequest request)

Create service principal secret.

Create a secret for the given service principal.

delete

public void delete(long servicePrincipalId,
                   String secretId)

delete

public void delete(DeleteServicePrincipalSecretRequest request)

Delete service principal secret.

Delete a secret from the given service principal.

list

public Iterable<SecretInfo> list(long servicePrincipalId)

list

public Iterable<SecretInfo> list(ListServicePrincipalSecretsRequest request)

List service principal secrets.

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 ServicePrincipalSecretsService impl()