com.databricks.sdk.service.iam

Class ServicePrincipalsAPI

java.lang.Object

com.databricks.sdk.service.iam.ServicePrincipalsAPI

@Generated
public class ServicePrincipalsAPI
extends Object

Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms. Databricks recommends creating service principals to run production jobs or modify production data. If all processes that act on production data run with service principals, interactive users do not need any write, delete, or modify privileges in production. This eliminates the risk of a user overwriting production data by accident.

Constructor Summary

Constructors

Constructor and Description
ServicePrincipalsAPI(ApiClient apiClient) Regular-use constructor
ServicePrincipalsAPI(ServicePrincipalsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ServicePrincipal	create(ServicePrincipal request) Create a service principal.
void	delete(DeleteServicePrincipalRequest request) Delete a service principal.
void	delete(String id)
ServicePrincipal	get(GetServicePrincipalRequest request) Get service principal details.
ServicePrincipal	get(String id)
ServicePrincipalsService	impl()
Iterable<ServicePrincipal>	list(ListServicePrincipalsRequest request) List service principals.
void	patch(PartialUpdate request) Update service principal details.
void	patch(String id)
void	update(ServicePrincipal request) Replace service principal.
void	update(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePrincipalsAPI

public ServicePrincipalsAPI(ApiClient apiClient)

Regular-use constructor

ServicePrincipalsAPI

public ServicePrincipalsAPI(ServicePrincipalsService mock)

Constructor for mocks

Method Detail

create

public ServicePrincipal create(ServicePrincipal request)

Create a service principal.

Creates a new service principal in the Databricks workspace.

delete

public void delete(String id)

delete

public void delete(DeleteServicePrincipalRequest request)

Delete a service principal.

Delete a single service principal in the Databricks workspace.

get

public ServicePrincipal get(String id)

get

public ServicePrincipal get(GetServicePrincipalRequest request)

Get service principal details.

Gets the details for a single service principal define in the Databricks workspace.

list

public Iterable<ServicePrincipal> list(ListServicePrincipalsRequest request)

List service principals.

Gets the set of service principals associated with a Databricks workspace.

patch

public void patch(String id)

patch

public void patch(PartialUpdate request)

Update service principal details.

Partially updates the details of a single service principal in the Databricks workspace.

update

public void update(String id)

update

public void update(ServicePrincipal request)

Replace service principal.

Updates the details of a single service principal.

This action replaces the existing service principal with the same name.

impl

public ServicePrincipalsService impl()