Get Roles APIedit

Get Roles Requestedit

Retrieving a role can be performed using the security().getRoles() method and by setting the role name on GetRolesRequest:

GetRolesRequest request = new GetRolesRequest("my_role");

Retrieving multiple roles can be performed using the security().getRoles() method and by setting multiple role names on GetRolesRequest:

GetRolesRequest request = new GetRolesRequest("my_role", "my_role2");
GetRolesResponse response =, RequestOptions.DEFAULT);

Retrieving all roles can be performed using the security().getRoles() method without specifying any role names on GetRolesRequest:

GetRolesRequest request = new GetRolesRequest();
GetRolesResponse response =, RequestOptions.DEFAULT);

Synchronous executionedit

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

GetRolesResponse response =, 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 executionedit

Executing a GetRolesRequest 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-roles method:, RequestOptions.DEFAULT, listener); 

The GetRolesRequest 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-roles looks like:

listener = new ActionListener<GetRolesResponse>() {
    public void onResponse(GetRolesResponse getRolesResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole GetRolesRequest fails.

Get Roles Responseedit

The returned GetRolesResponse allows getting information about the retrieved roles as follows.

List<Role> roles = response.getRoles();