Invalidate API Key APIedit
API Key(s) can be invalidated using this API.
Invalidate API Key Requestedit
The InvalidateApiKeyRequest
supports invalidating
- A specific API key
- All API keys for a specific realm
- All API keys for a specific user
- All API keys for a specific user in a specific realm
- A specific key or all API keys owned by the current authenticated user
Specific API keys by a list of API key idsedit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingApiKeyIds( Arrays.asList("kI3QZHYBnpSXoDRq1XzR", "ko3SZHYBnpSXoDRqk3zm"), false);
Specific API key by API key nameedit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingApiKeyName(createApiKeyResponse2.getName(), false);
All API keys for realmedit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingRealmName("default_file");
All API keys for useredit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingUserName("test_user");
All API key for user in realmedit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.usingRealmAndUserName("default_file", "test_user");
Retrieve all API keys for the current authenticated useredit
InvalidateApiKeyRequest invalidateApiKeyRequest = InvalidateApiKeyRequest.forOwnedApiKeys();
Synchronous executionedit
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 executionedit
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:
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:
Invalidate API Key Responseedit
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);