Class ChangePasswordRequest

All Implemented Interfaces:

public class ChangePasswordRequest
extends RequestBase
implements JsonpSerializable
Changes the passwords of users in the native realm and built-in users.
See Also:
API specification
  • Field Details

  • Method Details

    • of

      public static ChangePasswordRequest of​(java.util.function.Function<ChangePasswordRequest.Builder,​ObjectBuilder<ChangePasswordRequest>> fn)
    • password

      @Nullable public final java.lang.String password()
      The new password value. Passwords must be at least 6 characters long.

      API name: password

    • passwordHash

      @Nullable public final java.lang.String passwordHash()
      A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the setting.

      API name: password_hash

    • refresh

      @Nullable public final Refresh refresh()
      If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

      API name: refresh

    • username

      @Nullable public final java.lang.String username()
      The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user.

      API name: username

    • serialize

      public void serialize​( generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable
    • serializeInternal

      protected void serializeInternal​( generator, JsonpMapper mapper)
    • setupChangePasswordRequestDeserializer

      protected static void setupChangePasswordRequestDeserializer​(ObjectDeserializer<ChangePasswordRequest.Builder> op)