com.databricks.sdk.service.iam

Class GroupsAPI

java.lang.Object

com.databricks.sdk.service.iam.GroupsAPI

@Generated
public class GroupsAPI
extends Object

Groups simplify identity management, making it easier to assign access to Databricks workspace, 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 workspace identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.

Constructor Summary

Constructors

Constructor and Description
GroupsAPI(ApiClient apiClient) Regular-use constructor
GroupsAPI(GroupsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Group	create(Group request) Create a new group.
void	delete(DeleteGroupRequest request) Delete a group.
void	delete(String id)
Group	get(GetGroupRequest request) Get group details.
Group	get(String id)
GroupsService	impl()
Iterable<Group>	list(ListGroupsRequest request) List group details.
void	patch(PartialUpdate request) Update group details.
void	patch(String id)
void	update(Group request) Replace a group.
void	update(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsAPI

public GroupsAPI(ApiClient apiClient)

Regular-use constructor

GroupsAPI

public GroupsAPI(GroupsService mock)

Constructor for mocks

Method Detail

create

public Group create(Group request)

Create a new group.

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

delete

public void delete(String id)

delete

public void delete(DeleteGroupRequest request)

Delete a group.

Deletes a group from the Databricks workspace.

get

public Group get(String id)

get

public Group get(GetGroupRequest request)

Get group details.

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

list

public Iterable<Group> list(ListGroupsRequest request)

List group details.

Gets all details of the groups associated with the Databricks workspace.

patch

public void patch(String id)

patch

public void patch(PartialUpdate request)

Update group details.

Partially updates the details of a group.

update

public void update(String id)

update

public void update(Group request)

Replace a group.

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

impl

public GroupsService impl()