Delete Service Account Token API

edit

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

Delete Service Account Token Request

edit

A DeleteServiceAccountTokenRequest contains the namespace, service-name and token name of a service account token.

DeleteServiceAccountTokenRequest deleteServiceAccountTokenRequest =
    new DeleteServiceAccountTokenRequest("elastic", "fleet-server", "test-token");

Synchronous execution

edit

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

DeleteServiceAccountTokenResponse deleteServiceAccountTokenResponse =
    client.security().deleteServiceAccountToken(deleteServiceAccountTokenRequest, 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

edit

Executing a DeleteServiceAccountTokenRequest 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 delete-service-account-token method:

client.security().deleteServiceAccountTokenAsync(deleteServiceAccountTokenRequest, RequestOptions.DEFAULT, listener); 

The DeleteServiceAccountTokenRequest 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 delete-service-account-token looks like:

listener = new ActionListener<DeleteServiceAccountTokenResponse>() {
    @Override
    public void onResponse(DeleteServiceAccountTokenResponse deleteServiceAccountTokenResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole DeleteServiceAccountTokenRequest fails.

Delete Service Account Token Response

edit

The returned DeleteServiceAccountTokenResponse allows to retrieve information about the executed operation as follows:

final boolean found = deleteServiceAccountTokenResponse.isAcknowledged(); 

whether the given service account token was found