Package com.influxdb.client

Interface UsersApi

@ThreadSafe public interface UsersApi
The client of the InfluxDB 2.x that implement User HTTP API endpoint.
Author:
Jakub Bednar (bednar@github) (11/09/2018 10:05)

  • Method Details

    • createUser

      @Nonnull User createUser(@Nonnull User user)
      Creates a new user and sets User.getId() with the new identifier.
      Parameters:
      user - the user to create
      Returns:
      User created

    • createUser

      @Nonnull User createUser(@Nonnull String name)
      Creates a new user and sets User.getId() with the new identifier.
      Parameters:
      name - name of the user
      Returns:
      User created

    • updateUser

      @Nonnull User updateUser(@Nonnull User user)
      Update an user.
      Parameters:
      user - user update to apply
      Returns:
      user updated

    • updateUserPassword

      void updateUserPassword(@Nonnull User user, @Nonnull String oldPassword, @Nonnull String newPassword)
      Update password to an user.
      Parameters:
      user - user to update password
      oldPassword - old password
      newPassword - new password

    • updateUserPassword

      void updateUserPassword(@Nonnull String userID, @Nonnull String oldPassword, @Nonnull String newPassword)
      Update password to an user.
      Parameters:
      userID - ID of user to update password
      oldPassword - old password
      newPassword - new password

    • deleteUser

      void deleteUser(@Nonnull User user)
      Delete an user.
      Parameters:
      user - user to delete

    • deleteUser

      void deleteUser(@Nonnull String userID)
      Delete an user.
      Parameters:
      userID - ID of user to delete

    • cloneUser

      @Nonnull User cloneUser(@Nonnull String clonedName, @Nonnull String userID)
      Clone an user.
      Parameters:
      clonedName - name of cloned user
      userID - ID of user to clone
      Returns:
      cloned user

    • cloneUser

      @Nonnull User cloneUser(@Nonnull String clonedName, @Nonnull User user)
      Clone an user.
      Parameters:
      clonedName - name of cloned user
      user - user to clone
      Returns:
      cloned user

    • me

      @Nonnull User me()
      Returns currently authenticated user.
      Returns:
      user

    • meUpdatePassword

      void meUpdatePassword(@Nonnull String oldPassword, @Nonnull String newPassword)
      Update the password to a currently authenticated user.
      Parameters:
      oldPassword - old password
      newPassword - new password

    • findUserByID

      @Nonnull User findUserByID(@Nonnull String userID)
      Retrieve an user.
      Parameters:
      userID - ID of user to get
      Returns:
      user details

    • findUsers

      @Nonnull List<User> findUsers()
      List all users.
      Returns:
      List all users