Package co.elastic.clients.elasticsearch.security

Class PutUserRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.PutUserRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutUserRequest extends RequestBase implements JsonpSerializable
Create or update users.

Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API.

See Also:

  • Field Details

  • Method Details

    • of

      public static PutUserRequest of(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)

    • email

      @Nullable public final String email()
      The email of the user.

      API name: email

    • enabled

      @Nullable public final Boolean enabled()
      Specifies whether the user is enabled.

      API name: enabled

    • fullName

      @Nullable public final String fullName()
      The full name of the user.

      API name: full_name

    • metadata

      public final Map<String,JsonData> metadata()
      Arbitrary metadata that you want to associate with the user.

      API name: metadata

    • password

      @Nullable public final String password()
      The user's password. Passwords must be at least 6 characters long. When adding a user, one of password or password_hash is required. When updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password

      API name: password

    • passwordHash

      @Nullable public final String passwordHash()
      A hash of the user's password. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the xpack.security.authc.password_hashing.algorithm setting in the user cache and password hash algorithm documentation. Using this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons. The password parameter and the password_hash parameter cannot be used in the same request.

      API name: password_hash

    • refresh

      @Nullable public final Refresh refresh()
      Valid values are true, false, and wait_for. These values have the same meaning as in the index API, but the default value for this API is true.

      API name: refresh

    • roles

      public final List<String> roles()
      A set of roles the user has. The roles determine the user's access permissions. To create a user without any roles, specify an empty list ([]).

      API name: roles

    • username

      public final String username()
      Required - An identifier for the user.

      NOTE: Usernames must be at least 1 and no more than 507 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block. Leading or trailing whitespace is not allowed.

      API name: username

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupPutUserRequestDeserializer

      protected static void setupPutUserRequestDeserializer(ObjectDeserializer<PutUserRequest.Builder> op)