Class ChangePasswordRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.ChangePasswordRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class ChangePasswordRequest
extends RequestBase
implements JsonpSerializable
Changes the passwords of users in the native realm and built-in users.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ChangePasswordRequest>
Json deserializer forChangePasswordRequest
static final Endpoint<ChangePasswordRequest,
ChangePasswordResponse, ErrorResponse> Endpoint "security.change_password
". -
Method Summary
Modifier and TypeMethodDescriptionstatic ChangePasswordRequest
final String
password()
The new password value.final String
A hash of the new password value.final Refresh
refresh()
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
username()
The user whose password you want to change.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forChangePasswordRequest
-
_ENDPOINT
Endpoint "security.change_password
".
-
-
Method Details
-
of
public static ChangePasswordRequest of(Function<ChangePasswordRequest.Builder, ObjectBuilder<ChangePasswordRequest>> fn) -
password
The new password value. Passwords must be at least 6 characters long.API name:
password
-
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 thexpack.security.authc.password_hashing.algorithm
setting.API name:
password_hash
-
refresh
Iftrue
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.API name:
refresh
-
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupChangePasswordRequestDeserializer
protected static void setupChangePasswordRequestDeserializer(ObjectDeserializer<ChangePasswordRequest.Builder> op)
-