Package co.elastic.clients.elasticsearch.security

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

Change passwords.

Change 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 for ChangePasswordRequest.

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 final JsonpDeserializer<ChangePasswordRequest>	_DESERIALIZER	Json deserializer for ChangePasswordRequest
static final Endpoint<ChangePasswordRequest,ChangePasswordResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.change_password".

Method Summary

Modifier and Type	Method	Description
static ChangePasswordRequest	of(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)
final String	password()	The new password value.
final String	passwordHash()	A hash of the new password value.
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.
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)
final String	username()	The user whose password you want to change.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ChangePasswordRequest> _DESERIALIZER

Json deserializer for ChangePasswordRequest

_ENDPOINT

public static final Endpoint<ChangePasswordRequest,ChangePasswordResponse,ErrorResponse> _ENDPOINT

Endpoint "security.change_password".

Method Details

of

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

password

@Nullable
public final String password()

The new password value. Passwords must be at least 6 characters long.

API name: password

passwordHash

@Nullable
public final 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 xpack.security.authc.password_hashing.algorithm 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 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(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)

setupChangePasswordRequestDeserializer

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