Create Service Account Token APIedit

Index-based service account token can be created using this API.

Create Service Account Token Requestedit

A CreateServiceAccountTokenRequest contains the namespace and service-name of a service account and an optional name for the service account token.

CreateServiceAccountTokenRequest createServiceAccountTokenRequest =
    new CreateServiceAccountTokenRequest("elastic", "fleet-server", "my_token_1");

A token name will be auto generated if the CreateServiceAccountTokenRequest does not specify it:

CreateServiceAccountTokenRequest createServiceAccountTokenRequest =
    new CreateServiceAccountTokenRequest("elastic", "fleet-server");

Synchronous executionedit

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

CreateServiceAccountTokenResponse createServiceAccountTokenResponse =, 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 CreateServiceAccountTokenRequest 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 create-service-account-token method:, RequestOptions.DEFAULT, listener); 

The CreateServiceAccountTokenRequest 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 create-service-account-token looks like:

listener = new ActionListener<CreateServiceAccountTokenResponse>() {
    public void onResponse(CreateServiceAccountTokenResponse createServiceAccountTokenResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole CreateServiceAccountTokenRequest fails.

Create Service Account Token Responseedit

The returned CreateServiceAccountTokenResponse contains the name and value of the service account token.

final String tokenName = createServiceAccountTokenResponse.getName(); 
final SecureString tokenValue = createServiceAccountTokenResponse.getValue(); 

Name of the service account token

Value of the service account token to be used as the bearer authentication header