com.edmunds.rest.databricks.service

Interface ScimService

All Known Implementing Classes:

ScimServiceImpl

public interface ScimService

The wrapper around the databricks SCIM API. Note that currently the API is in public preview mode - modifications are expected.

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#

Method Summary

Modifier and Type	Method and Description
void	addUsersToGroup(long groupId, long[] userIds) Update a group in Databricks by adding new members.
long	createGroup(GroupDTO group) Creates a group in the Databricks workspace.
long	createUser(UserDTO userDTO) Create a user in the Databricks workspace.
void	deleteGroup(long id) Removes a group from the workspace.
void	deleteUser(long id) Inactivates an user.
void	editUser(UserDTO userDTO) Updates an user.
GroupDTO	getGroup(long id) Gets a group by id.
UserDTO	getUser(long id) Gets an user by id.
ListResponseDTO<GroupDTO>	listGroups() Retrieve a list of groups associated with a Databricks workspace.
ListResponseDTO<GroupDTO>	listGroups(String filters) Retrieve a list of groups associated with a Databricks workspace.
ListResponseDTO<UserDTO>	listUsers() Retrieve a list of users associated with a Databricks workspace.
ListResponseDTO<UserDTO>	listUsers(String filters) Retrieve a list of users associated with a Databricks workspace.
void	removeUsersFromGroup(long groupId, long[] userIds) Update a group in Databricks by removing members.

Method Detail

getUser

UserDTO getUser(long id)
         throws IOException,
                DatabricksRestException

Gets an user by id.

Parameters:

id - user id

Returns:

POJO representing an user

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-user-by-id

deleteUser

void deleteUser(long id)
         throws IOException,
                DatabricksRestException

Inactivates an user.

Parameters:

id - user id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#delete-user-by-id

listUsers

ListResponseDTO<UserDTO> listUsers(String filters)
                            throws IOException,
                                   DatabricksRestException

Retrieve a list of users associated with a Databricks workspace.

Parameters:

filters - query filters, can be null @see https://docs.databricks.com/dev-tools/api/latest/scim.html#scim-filters

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-users

listUsers

ListResponseDTO<UserDTO> listUsers()
                            throws IOException,
                                   DatabricksRestException

Retrieve a list of users associated with a Databricks workspace. No search criteria are provided.

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-users

createUser

long createUser(UserDTO userDTO)
         throws IOException,
                DatabricksRestException

Create a user in the Databricks workspace.

Parameters:

userDTO - POJO representing an user

Returns:

the user id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#create-user

editUser

void editUser(UserDTO userDTO)
       throws IOException,
              DatabricksRestException

Updates an user.

Parameters:

userDTO - POJO representing an user

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-user-by-id-put

getGroup

GroupDTO getGroup(long id)
           throws IOException,
                  DatabricksRestException

Gets a group by id.

Parameters:

id - the group id

Returns:

POJO representing an group

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-group-by-id

deleteGroup

void deleteGroup(long id)
          throws IOException,
                 DatabricksRestException

Removes a group from the workspace. The users associated are not removed

Parameters:

id - group id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#delete-group

listGroups

ListResponseDTO<GroupDTO> listGroups(String filters)
                              throws IOException,
                                     DatabricksRestException

Retrieve a list of groups associated with a Databricks workspace.

Parameters:

filters - query filters, can be null @see https://docs.databricks.com/dev-tools/api/latest/scim.html#scim-filters

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-groups

listGroups

ListResponseDTO<GroupDTO> listGroups()
                              throws IOException,
                                     DatabricksRestException

Retrieve a list of groups associated with a Databricks workspace. No search criteria are provided.

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-groups

createGroup

long createGroup(GroupDTO group)
          throws IOException,
                 DatabricksRestException

Creates a group in the Databricks workspace.

Parameters:

group - POJO representing an group

Returns:

the group id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#create-group

addUsersToGroup

void addUsersToGroup(long groupId,
                     long[] userIds)
              throws IOException,
                     DatabricksRestException

Update a group in Databricks by adding new members.

Parameters:

groupId - group id

userIds - user ids

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-group

removeUsersFromGroup

void removeUsersFromGroup(long groupId,
                          long[] userIds)
                   throws IOException,
                          DatabricksRestException

Update a group in Databricks by removing members.

Parameters:

groupId - group id

userIds - user ids

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-group