com.databricks.sdk.service.iam

Class AccountGroupsAPI

java.lang.Object

com.databricks.sdk.service.iam.AccountGroupsAPI

@Generated
public class AccountGroupsAPI
extends Object

Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects.

It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.

Constructor Summary

Constructors

Constructor and Description
AccountGroupsAPI(AccountGroupsService mock) Constructor for mocks
AccountGroupsAPI(ApiClient apiClient) Regular-use constructor

Method Summary

Modifier and Type	Method and Description
Group	create(Group request) Creates a group in the Databricks account with a unique name, using the supplied group details.
void	delete(DeleteAccountGroupRequest request) Deletes a group from the Databricks account.
void	delete(String id)
Group	get(GetAccountGroupRequest request) Gets the information for a specific group in the Databricks account.
Group	get(String id)
AccountGroupsService	impl()
Iterable<Group>	list(ListAccountGroupsRequest request) Gets all details of the groups associated with the Databricks account.
void	patch(PartialUpdate request) Partially updates the details of a group.
void	update(Group request) Updates the details of a group by replacing the entire group entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountGroupsAPI

public AccountGroupsAPI(ApiClient apiClient)

Regular-use constructor

AccountGroupsAPI

public AccountGroupsAPI(AccountGroupsService mock)

Constructor for mocks

Method Detail

create

public Group create(Group request)

Creates a group in the Databricks account with a unique name, using the supplied group details.

delete

public void delete(String id)

delete

public void delete(DeleteAccountGroupRequest request)

Deletes a group from the Databricks account.

get

public Group get(String id)

get

public Group get(GetAccountGroupRequest request)

Gets the information for a specific group in the Databricks account.

list

public Iterable<Group> list(ListAccountGroupsRequest request)

Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint will not return members. Instead, members should be retrieved by iterating through `Get group details`.

patch

public void patch(PartialUpdate request)

Partially updates the details of a group.

update

public void update(Group request)

Updates the details of a group by replacing the entire group entity.

impl

public AccountGroupsService impl()