Get Users API

Get Users Request

Retrieving a user can be performed using the security().getUsers() method and by setting the username on GetUsersRequest:

GetUsersRequest request = new GetUsersRequest(usernames[0]);

Retrieving multiple users can be performed using the security().getUsers() method and by setting multiple usernames on GetUsersRequest:

GetUsersRequest request = new GetUsersRequest(usernames);
GetUsersResponse response = client.security().getUsers(request, RequestOptions.DEFAULT);

Retrieving all users can be performed using the security().getUsers() method without specifying any usernames on GetUsersRequest:

GetUsersRequest request = new GetUsersRequest();
GetUsersResponse response = client.security().getUsers(request, RequestOptions.DEFAULT);

Synchronous Execution

When executing a GetUsersRequest in the following manner, the client waits for the GetUsersResponse to be returned before continuing with code execution:

GetUsersResponse response = client.security().getUsers(request, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous Execution

Executing a GetUsersRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous get-users method:

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

The GetUsersRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for get-users looks like:

listener = new ActionListener<GetUsersResponse>() {
    @Override
    public void onResponse(GetUsersResponse getRolesResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole GetUsersRequest fails.

Get Users Response

The returned GetUsersResponse allows getting information about the retrieved users as follows.

List<User> users = new ArrayList<>(1);
users.addAll(response.getUsers());