WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Create Service Account Token API
editCreate Service Account Token API
editIndex-based service account token can be created using this API.
Create Service Account Token Request
editA 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 execution
editWhen executing a CreateServiceAccountTokenRequest
in the following manner, the client waits
for the CreateServiceAccountTokenResponse
to be returned before continuing with code execution:
CreateServiceAccountTokenResponse createServiceAccountTokenResponse = client.security().createServiceAccountToken(createServiceAccountTokenRequest, 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
editExecuting 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:
client.security().createServiceAccountTokenAsync(createServiceAccountTokenRequest, RequestOptions.DEFAULT, listener);
The |
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:
Create Service Account Token Response
editThe returned CreateServiceAccountTokenResponse
contains the name and value of the service account token.