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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChangePasswordRequest.Builder
Builder forChangePasswordRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ChangePasswordRequest>
_DESERIALIZER
Json deserializer forChangePasswordRequest
static Endpoint<ChangePasswordRequest,ChangePasswordResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.change_password
". -
Method Summary
Modifier and Type Method Description static ChangePasswordRequest
of(java.util.function.Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)
java.lang.String
password()
The new password value.java.lang.String
passwordHash()
A hash of the new password value.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
setupChangePasswordRequestDeserializer(ObjectDeserializer<ChangePasswordRequest.Builder> op)
java.lang.String
username()
The user whose password you want to change.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forChangePasswordRequest
-
_ENDPOINT
public static final Endpoint<ChangePasswordRequest,ChangePasswordResponse,ErrorResponse> _ENDPOINTEndpoint "security.change_password
".
-
-
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 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
@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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupChangePasswordRequestDeserializer
protected static void setupChangePasswordRequestDeserializer(ObjectDeserializer<ChangePasswordRequest.Builder> op)
-