Class 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 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)
        Create a new user.

        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)
        Delete a user.

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

      • get

        public User get​(GetUserRequest request)
        Get user details.

        Gets information for a specific user in Databricks workspace.

      • list

        public Iterable<User> list​(ListUsersRequest request)
        List users.

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

      • patch

        public void patch​(String id)
      • patch

        public void patch​(PartialUpdate request)
        Update user details.

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

      • update

        public void update​(String id)
      • update

        public void update​(User request)
        Replace a user.

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