com.databricks.sdk.service.iam

Class UsersAPI

java.lang.Object

com.databricks.sdk.service.iam.UsersAPI

@Generated
public class UsersAPI
extends Object

User identities recognized by Databricks and represented by email addresses.

Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks workspace. SCIM streamlines onboarding a new employee or team by using your identity provider to create users and groups in Databricks workspace and give them the proper level of access. When a user leaves your organization or no longer needs access to Databricks workspace, admins can terminate the user in your identity provider and that user’s account will also be removed from Databricks workspace. This ensures a consistent offboarding process and prevents unauthorized users from accessing sensitive data.

Constructor Summary

Constructors

Constructor and Description
UsersAPI(ApiClient apiClient) Regular-use constructor
UsersAPI(UsersService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
User	create(User request) Creates a new user in the Databricks workspace.
void	delete(DeleteUserRequest request) Deletes a user.
void	delete(String id)
User	get(GetUserRequest request) Gets information for a specific user in Databricks workspace.
User	get(String id)
GetPasswordPermissionLevelsResponse	getPermissionLevels() Gets the permission levels that a user can have on an object.
PasswordPermissions	getPermissions() Gets the permissions of all passwords.
UsersService	impl()
Iterable<User>	list(ListUsersRequest request) Gets details for all the users associated with a Databricks workspace.
void	patch(PartialUpdate request) Partially updates a user resource by applying the supplied operations on specific user attributes.
PasswordPermissions	setPermissions(PasswordPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
void	update(User request) Replaces a user's information with the data supplied in request.
PasswordPermissions	updatePermissions(PasswordPermissionsRequest request) Updates the permissions on all passwords.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersAPI

public UsersAPI(ApiClient apiClient)

Regular-use constructor

UsersAPI

public UsersAPI(UsersService mock)

Constructor for mocks

Method Detail

create

public User create(User request)

Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.

delete

public void delete(String id)

delete

public void delete(DeleteUserRequest request)

Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user.

get

public User get(String id)

get

public User get(GetUserRequest request)

Gets information for a specific user in Databricks workspace.

getPermissionLevels

public GetPasswordPermissionLevelsResponse getPermissionLevels()

Gets the permission levels that a user can have on an object.

getPermissions

public PasswordPermissions getPermissions()

Gets the permissions of all passwords. Passwords can inherit permissions from their root object.

list

public Iterable<User> list(ListUsersRequest request)

Gets details for all the users associated with a Databricks workspace.

patch

public void patch(PartialUpdate request)

Partially updates a user resource by applying the supplied operations on specific user attributes.

setPermissions

public PasswordPermissions setPermissions(PasswordPermissionsRequest request)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

update

public void update(User request)

Replaces a user's information with the data supplied in request.

updatePermissions

public PasswordPermissions updatePermissions(PasswordPermissionsRequest request)

Updates the permissions on all passwords. Passwords can inherit permissions from their root object.

impl

public UsersService impl()