com.databricks.sdk.service.iam

Interface UsersV2Service

@Generated
public interface UsersV2Service

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.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
User	create(CreateUserRequest createUserRequest) Creates a new user in the Databricks workspace.
void	delete(DeleteUserRequest deleteUserRequest) Deletes a user.
User	get(GetUserRequest getUserRequest) Gets information for a specific user in Databricks workspace.
GetPasswordPermissionLevelsResponse	getPermissionLevels(GetPasswordPermissionLevelsRequest getPasswordPermissionLevelsRequest) Gets the permission levels that a user can have on an object.
PasswordPermissions	getPermissions(GetPasswordPermissionsRequest getPasswordPermissionsRequest) Gets the permissions of all passwords.
ListUsersResponse	list(ListUsersRequest listUsersRequest) Gets details for all the users associated with a Databricks workspace.
void	patch(PatchUserRequest patchUserRequest) Partially updates a user resource by applying the supplied operations on specific user attributes.
PasswordPermissions	setPermissions(PasswordPermissionsRequest passwordPermissionsRequest) Sets permissions on an object, replacing existing permissions if they exist.
void	update(UpdateUserRequest updateUserRequest) Replaces a user's information with the data supplied in request.
PasswordPermissions	updatePermissions(PasswordPermissionsRequest passwordPermissionsRequest) Updates the permissions on all passwords.

Method Detail

create

User create(CreateUserRequest createUserRequest)

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

delete

void delete(DeleteUserRequest deleteUserRequest)

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

get

User get(GetUserRequest getUserRequest)

Gets information for a specific user in Databricks workspace.

getPermissionLevels

GetPasswordPermissionLevelsResponse getPermissionLevels(GetPasswordPermissionLevelsRequest getPasswordPermissionLevelsRequest)

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

getPermissions

PasswordPermissions getPermissions(GetPasswordPermissionsRequest getPasswordPermissionsRequest)

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

list

ListUsersResponse list(ListUsersRequest listUsersRequest)

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

patch

void patch(PatchUserRequest patchUserRequest)

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

setPermissions

PasswordPermissions setPermissions(PasswordPermissionsRequest passwordPermissionsRequest)

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

void update(UpdateUserRequest updateUserRequest)

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

updatePermissions

PasswordPermissions updatePermissions(PasswordPermissionsRequest passwordPermissionsRequest)

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