New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Disable User API Put Role API »
Elastic Docs ›Java REST Client [7.9] ›Java High Level REST Client ›Security APIs

Change Password API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Change Password API

edit

Execution

edit

A user’s password can be changed using the security().changePassword() method:

ChangePasswordRequest request = new ChangePasswordRequest("change_password_user", newPassword, RefreshPolicy.NONE);
boolean response = client.security().changePassword(request, RequestOptions.DEFAULT);

Response

edit

The returned Boolean indicates the request status.

Asynchronous Execution

edit

This request can be executed asynchronously:

client.security().changePasswordAsync(request, RequestOptions.DEFAULT, listener);

The ChangePassword request to execute and the ActionListener to use when the execution completes.

The asynchronous method does not block and returns immediately. Once the request has completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed.

A typical listener for a Boolean looks like:

ChangePasswordRequest request = new ChangePasswordRequest("change_password_user", password, RefreshPolicy.NONE);
ActionListener<Boolean> listener = new ActionListener<Boolean>() {
    @Override
    public void onResponse(Boolean response) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

Called when the execution is successfully completed. The response is provided as an argument.

Called in case of failure. The raised exception is provided as an argument.
« Disable User API Put Role API »
Was this helpful?
Feedback