Invalidate API Key API

API Key(s) can be invalidated using this API.

Invalidate API Key Request

The InvalidateApiKeyRequest supports invalidating

  1. A specific API key
  2. All API keys for a specific realm
  3. All API keys for a specific user
  4. All API keys for a specific user in a specific realm

Specific API key by API key id

InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingApiKeyId(createApiKeyResponse1.getId());

Specific API key by API key name

InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingApiKeyName(createApiKeyResponse2.getName());

All API keys for realm

InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingRealmName("default_file");

All API keys for user

InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingUserName("test_user");

All API key for user in realm

InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingRealmAndUserName("default_file", "test_user");

Synchronous Execution

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

InvalidateApiKeyResponse invalidateApiKeyResponse = client.security().invalidateApiKey(invalidateApiKeyRequest,
        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 InvalidateApiKeyRequest 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 invalidate-api-key method:

client.security().invalidateApiKeyAsync(invalidateApiKeyRequest, RequestOptions.DEFAULT, listener); 

The InvalidateApiKeyRequest 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 invalidate-api-key looks like:

listener = new ActionListener<InvalidateApiKeyResponse>() {
    @Override
    public void onResponse(InvalidateApiKeyResponse invalidateApiKeyResponse) {
        
    }

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

Called when the execution is successfully completed.

Called when the whole InvalidateApiKeyRequest fails.

Invalidate API Key Response

The returned InvalidateApiKeyResponse contains the information regarding the API keys that the request invalidated.

invalidatedApiKeys
Available using getInvalidatedApiKeys lists the API keys that this request invalidated.
previouslyInvalidatedApiKeys
Available using getPreviouslyInvalidatedApiKeys lists the API keys that this request attempted to invalidate but were already invalid.
errors
Available using getErrors contains possible errors that were encountered while attempting to invalidate API keys.
InvalidateApiKeyResponse invalidateApiKeyResponse = client.security().invalidateApiKey(invalidateApiKeyRequest,
        RequestOptions.DEFAULT);