Package org.elasticsearch.client

Class SecurityClient

java.lang.Object

org.elasticsearch.client.SecurityClient

public final class SecurityClient
extends Object

A wrapper for the RestHighLevelClient that provides methods for accessing the Security APIs.

See Security APIs on elastic.co

Method Summary

Modifier and Type	Method	Description
AuthenticateResponse	authenticate(RequestOptions options)	Authenticate the current user and return all the information about the authenticated user.
Cancellable	authenticateAsync(RequestOptions options, ActionListener<AuthenticateResponse> listener)	Authenticate the current user asynchronously and return all the information about the authenticated user.
boolean	changePassword(RequestOptions options, ChangePasswordRequest request)	Deprecated. use changePassword(ChangePasswordRequest, RequestOptions) instead
boolean	changePassword(ChangePasswordRequest request, RequestOptions options)	Change the password of a user of a native realm or built-in user synchronously.
Cancellable	changePasswordAsync(RequestOptions options, ChangePasswordRequest request, ActionListener<Boolean> listener)	Deprecated. use changePasswordAsync(ChangePasswordRequest, RequestOptions, ActionListener) instead
Cancellable	changePasswordAsync(ChangePasswordRequest request, RequestOptions options, ActionListener<Boolean> listener)	Change the password of a user of a native realm or built-in user asynchronously.
ClearRealmCacheResponse	clearRealmCache(ClearRealmCacheRequest request, RequestOptions options)	Clears the cache in one or more realms.
Cancellable	clearRealmCacheAsync(ClearRealmCacheRequest request, RequestOptions options, ActionListener<ClearRealmCacheResponse> listener)	Clears the cache in one or more realms asynchronously.
ClearRolesCacheResponse	clearRolesCache(ClearRolesCacheRequest request, RequestOptions options)	Clears the roles cache for a set of roles.
Cancellable	clearRolesCacheAsync(ClearRolesCacheRequest request, RequestOptions options, ActionListener<ClearRolesCacheResponse> listener)	Clears the roles cache for a set of roles asynchronously.
CreateApiKeyResponse	createApiKey(CreateApiKeyRequest request, RequestOptions options)	Create an API Key. See the docs for more.
Cancellable	createApiKeyAsync(CreateApiKeyRequest request, RequestOptions options, ActionListener<CreateApiKeyResponse> listener)	Asynchronously creates an API key. See the docs for more.
CreateTokenResponse	createToken(CreateTokenRequest request, RequestOptions options)	Creates an OAuth2 token.
Cancellable	createTokenAsync(CreateTokenRequest request, RequestOptions options, ActionListener<CreateTokenResponse> listener)	Asynchronously creates an OAuth2 token.
DelegatePkiAuthenticationResponse	delegatePkiAuthentication(DelegatePkiAuthenticationRequest request, RequestOptions options)	Get an Elasticsearch access token from an X509Certificate chain.
Cancellable	delegatePkiAuthenticationAsync(DelegatePkiAuthenticationRequest request, RequestOptions options, ActionListener<DelegatePkiAuthenticationResponse> listener)	Asynchronously get an Elasticsearch access token from an X509Certificate chain.
DeletePrivilegesResponse	deletePrivileges(DeletePrivilegesRequest request, RequestOptions options)	Removes application privilege(s) See the docs for more.
Cancellable	deletePrivilegesAsync(DeletePrivilegesRequest request, RequestOptions options, ActionListener<DeletePrivilegesResponse> listener)	Asynchronously removes an application privilege See the docs for more.
DeleteRoleResponse	deleteRole(DeleteRoleRequest request, RequestOptions options)	Removes role from the native realm.
Cancellable	deleteRoleAsync(DeleteRoleRequest request, RequestOptions options, ActionListener<DeleteRoleResponse> listener)	Removes role from the native realm.
DeleteRoleMappingResponse	deleteRoleMapping(DeleteRoleMappingRequest request, RequestOptions options)	Delete a role mapping.
Cancellable	deleteRoleMappingAsync(DeleteRoleMappingRequest request, RequestOptions options, ActionListener<DeleteRoleMappingResponse> listener)	Asynchronously delete a role mapping.
DeleteUserResponse	deleteUser(DeleteUserRequest request, RequestOptions options)	Removes user from the native realm synchronously.
Cancellable	deleteUserAsync(DeleteUserRequest request, RequestOptions options, ActionListener<DeleteUserResponse> listener)	Asynchronously deletes a user in the native realm.
boolean	disableUser(RequestOptions options, DisableUserRequest request)	Deprecated. use disableUser(DisableUserRequest, RequestOptions) instead
boolean	disableUser(DisableUserRequest request, RequestOptions options)	Disable a native realm or built-in user synchronously.
Cancellable	disableUserAsync(RequestOptions options, DisableUserRequest request, ActionListener<Boolean> listener)	Deprecated. use disableUserAsync(DisableUserRequest, RequestOptions, ActionListener) instead
Cancellable	disableUserAsync(DisableUserRequest request, RequestOptions options, ActionListener<Boolean> listener)	Disable a native realm or built-in user asynchronously.
boolean	enableUser(RequestOptions options, EnableUserRequest request)	Deprecated. use enableUser(EnableUserRequest, RequestOptions) instead
boolean	enableUser(EnableUserRequest request, RequestOptions options)	Enable a native realm or built-in user synchronously.
Cancellable	enableUserAsync(RequestOptions options, EnableUserRequest request, ActionListener<Boolean> listener)	Deprecated. use enableUserAsync(EnableUserRequest, RequestOptions, ActionListener) instead
Cancellable	enableUserAsync(EnableUserRequest request, RequestOptions options, ActionListener<Boolean> listener)	Enable a native realm or built-in user asynchronously.
GetApiKeyResponse	getApiKey(GetApiKeyRequest request, RequestOptions options)	Retrieve API Key(s) information. See the docs for more.
Cancellable	getApiKeyAsync(GetApiKeyRequest request, RequestOptions options, ActionListener<GetApiKeyResponse> listener)	Asynchronously retrieve API Key(s) information. See the docs for more.
GetBuiltinPrivilegesResponse	getBuiltinPrivileges(RequestOptions options)	Synchronously get builtin (cluster & index) privilege(s).
Cancellable	getBuiltinPrivilegesAsync(RequestOptions options, ActionListener<GetBuiltinPrivilegesResponse> listener)	Asynchronously get builtin (cluster & index) privilege(s).
GetPrivilegesResponse	getPrivileges(GetPrivilegesRequest request, RequestOptions options)	Synchronously get application privilege(s).
Cancellable	getPrivilegesAsync(GetPrivilegesRequest request, RequestOptions options, ActionListener<GetPrivilegesResponse> listener)	Asynchronously get application privilege(s).
GetRoleMappingsResponse	getRoleMappings(GetRoleMappingsRequest request, RequestOptions options)	Synchronously get role mapping(s).
Cancellable	getRoleMappingsAsync(GetRoleMappingsRequest request, RequestOptions options, ActionListener<GetRoleMappingsResponse> listener)	Asynchronously get role mapping(s).
GetRolesResponse	getRoles(GetRolesRequest request, RequestOptions options)	Retrieves roles from the native roles store.
Cancellable	getRolesAsync(GetRolesRequest request, RequestOptions options, ActionListener<GetRolesResponse> listener)	Asynchronously retrieves roles from the native roles store.
GetSslCertificatesResponse	getSslCertificates(RequestOptions options)	Synchronously retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
Cancellable	getSslCertificatesAsync(RequestOptions options, ActionListener<GetSslCertificatesResponse> listener)	Asynchronously retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
GetUserPrivilegesResponse	getUserPrivileges(RequestOptions options)	Retrieve the set of effective privileges held by the current user.
Cancellable	getUserPrivilegesAsync(RequestOptions options, ActionListener<GetUserPrivilegesResponse> listener)	Asynchronously retrieve the set of effective privileges held by the current user.
GetUsersResponse	getUsers(GetUsersRequest request, RequestOptions options)	Get a user, or list of users, in the native realm synchronously.
Cancellable	getUsersAsync(GetUsersRequest request, RequestOptions options, ActionListener<GetUsersResponse> listener)	Get a user, or list of users, in the native realm asynchronously.
HasPrivilegesResponse	hasPrivileges(HasPrivilegesRequest request, RequestOptions options)	Determine whether the current user has a specified list of privileges See the docs for more.
Cancellable	hasPrivilegesAsync(HasPrivilegesRequest request, RequestOptions options, ActionListener<HasPrivilegesResponse> listener)	Asynchronously determine whether the current user has a specified list of privileges See the docs for more.
InvalidateApiKeyResponse	invalidateApiKey(InvalidateApiKeyRequest request, RequestOptions options)	Invalidate API Key(s). See the docs for more.
Cancellable	invalidateApiKeyAsync(InvalidateApiKeyRequest request, RequestOptions options, ActionListener<InvalidateApiKeyResponse> listener)	Asynchronously invalidates API key(s). See the docs for more.
InvalidateTokenResponse	invalidateToken(InvalidateTokenRequest request, RequestOptions options)	Invalidates an OAuth2 token.
Cancellable	invalidateTokenAsync(InvalidateTokenRequest request, RequestOptions options, ActionListener<InvalidateTokenResponse> listener)	Asynchronously invalidates an OAuth2 token.
PutPrivilegesResponse	putPrivileges(PutPrivilegesRequest request, RequestOptions options)	Create or update application privileges.
Cancellable	putPrivilegesAsync(PutPrivilegesRequest request, RequestOptions options, ActionListener<PutPrivilegesResponse> listener)	Asynchronously create or update application privileges. See the docs for more.
PutRoleResponse	putRole(PutRoleRequest request, RequestOptions options)	Create or update a role in the native roles store.
Cancellable	putRoleAsync(PutRoleRequest request, RequestOptions options, ActionListener<PutRoleResponse> listener)	Asynchronously creates or updates a role in the native roles store.
PutRoleMappingResponse	putRoleMapping(PutRoleMappingRequest request, RequestOptions options)	Create/Update a role mapping.
Cancellable	putRoleMappingAsync(PutRoleMappingRequest request, RequestOptions options, ActionListener<PutRoleMappingResponse> listener)	Asynchronously create/update a role mapping.
PutUserResponse	putUser(PutUserRequest request, RequestOptions options)	Create/update a user in the native realm synchronously.
Cancellable	putUserAsync(PutUserRequest request, RequestOptions options, ActionListener<PutUserResponse> listener)	Asynchronously create/update a user in the native realm.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUsers

public GetUsersResponse getUsers(GetUsersRequest request,
                                 RequestOptions options)
                          throws IOException

Get a user, or list of users, in the native realm synchronously. See the docs for more information.

Parameters:

request - the request with the user's name

options - the request options (e.g., headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get users call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getUsersAsync

public Cancellable getUsersAsync(GetUsersRequest request,
                                 RequestOptions options,
                                 ActionListener<GetUsersResponse> listener)

Get a user, or list of users, in the native realm asynchronously. See the docs for more information.

Parameters:

request - the request with the user's name

options - the request options (e.g., headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

putUser

public PutUserResponse putUser(PutUserRequest request,
                               RequestOptions options)
                        throws IOException

Create/update a user in the native realm synchronously. See the docs for more.

Parameters:

request - the request with the user's information

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the put user call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

putUserAsync

public Cancellable putUserAsync(PutUserRequest request,
                                RequestOptions options,
                                ActionListener<PutUserResponse> listener)

Asynchronously create/update a user in the native realm. See the docs for more.

Parameters:

request - the request with the user's information

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteUser

public DeleteUserResponse deleteUser(DeleteUserRequest request,
                                     RequestOptions options)
                              throws IOException

Removes user from the native realm synchronously. See the docs for more.

Parameters:

request - the request with the user to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the delete user call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deleteUserAsync

public Cancellable deleteUserAsync(DeleteUserRequest request,
                                   RequestOptions options,
                                   ActionListener<DeleteUserResponse> listener)

Asynchronously deletes a user in the native realm. See the docs for more.

Parameters:

request - the request with the user to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

putRoleMapping

public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request,
                                             RequestOptions options)
                                      throws IOException

Create/Update a role mapping. See the docs for more.

Parameters:

request - the request with the role mapping information

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the put role mapping call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

putRoleMappingAsync

public Cancellable putRoleMappingAsync(PutRoleMappingRequest request,
                                       RequestOptions options,
                                       ActionListener<PutRoleMappingResponse> listener)

Asynchronously create/update a role mapping. See the docs for more.

Parameters:

request - the request with the role mapping information

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getRoleMappings

public GetRoleMappingsResponse getRoleMappings(GetRoleMappingsRequest request,
                                               RequestOptions options)
                                        throws IOException

Synchronously get role mapping(s). See the docs for more.

Parameters:

request - GetRoleMappingsRequest with role mapping name(s). If no role mapping name is provided then retrieves all role mappings.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get role mapping call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getRoleMappingsAsync

public Cancellable getRoleMappingsAsync(GetRoleMappingsRequest request,
                                        RequestOptions options,
                                        ActionListener<GetRoleMappingsResponse> listener)

Asynchronously get role mapping(s). See the docs for more.

Parameters:

request - GetRoleMappingsRequest with role mapping name(s). If no role mapping name is provided then retrieves all role mappings.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

enableUser

public boolean enableUser(EnableUserRequest request,
                          RequestOptions options)
                   throws IOException

Enable a native realm or built-in user synchronously. See the docs for more.

Parameters:

request - the request with the user to enable

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the request succeeded (the user is enabled)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

enableUser

@Deprecated
public boolean enableUser(RequestOptions options,
                          EnableUserRequest request)
                   throws IOException

Deprecated.

use enableUser(EnableUserRequest, RequestOptions) instead

Enable a native realm or built-in user synchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user to enable

Returns:

true if the request succeeded (the user is enabled)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

enableUserAsync

public Cancellable enableUserAsync(EnableUserRequest request,
                                   RequestOptions options,
                                   ActionListener<Boolean> listener)

Enable a native realm or built-in user asynchronously. See the docs for more.

Parameters:

request - the request with the user to enable

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

enableUserAsync

@Deprecated
public Cancellable enableUserAsync(RequestOptions options,
                                   EnableUserRequest request,
                                   ActionListener<Boolean> listener)

Deprecated.

use enableUserAsync(EnableUserRequest, RequestOptions, ActionListener) instead

Enable a native realm or built-in user asynchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user to enable

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

disableUser

public boolean disableUser(DisableUserRequest request,
                           RequestOptions options)
                    throws IOException

Disable a native realm or built-in user synchronously. See the docs for more.

Parameters:

request - the request with the user to disable

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the request succeeded (the user is disabled)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

disableUser

@Deprecated
public boolean disableUser(RequestOptions options,
                           DisableUserRequest request)
                    throws IOException

Deprecated.

use disableUser(DisableUserRequest, RequestOptions) instead

Disable a native realm or built-in user synchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user to disable

Returns:

true if the request succeeded (the user is disabled)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

disableUserAsync

public Cancellable disableUserAsync(DisableUserRequest request,
                                    RequestOptions options,
                                    ActionListener<Boolean> listener)

Disable a native realm or built-in user asynchronously. See the docs for more.

Parameters:

request - the request with the user to disable

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

disableUserAsync

@Deprecated
public Cancellable disableUserAsync(RequestOptions options,
                                    DisableUserRequest request,
                                    ActionListener<Boolean> listener)

Deprecated.

use disableUserAsync(DisableUserRequest, RequestOptions, ActionListener) instead

Disable a native realm or built-in user asynchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user to disable

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

authenticate

public AuthenticateResponse authenticate(RequestOptions options)
                                  throws IOException

Authenticate the current user and return all the information about the authenticated user. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the responsee from the authenticate user call

Throws:

IOException

authenticateAsync

public Cancellable authenticateAsync(RequestOptions options,
                                     ActionListener<AuthenticateResponse> listener)

Authenticate the current user asynchronously and return all the information about the authenticated user. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

hasPrivileges

public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request,
                                           RequestOptions options)
                                    throws IOException

Determine whether the current user has a specified list of privileges See the docs for more.

Parameters:

request - the request with the privileges to check

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the has privileges call

Throws:

IOException

hasPrivilegesAsync

public Cancellable hasPrivilegesAsync(HasPrivilegesRequest request,
                                      RequestOptions options,
                                      ActionListener<HasPrivilegesResponse> listener)

Asynchronously determine whether the current user has a specified list of privileges See the docs for more.

Parameters:

request - the request with the privileges to check

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getUserPrivileges

public GetUserPrivilegesResponse getUserPrivileges(RequestOptions options)
                                            throws IOException

Retrieve the set of effective privileges held by the current user.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Throws:

IOException

getUserPrivilegesAsync

public Cancellable getUserPrivilegesAsync(RequestOptions options,
                                          ActionListener<GetUserPrivilegesResponse> listener)

Asynchronously retrieve the set of effective privileges held by the current user.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

clearRealmCache

public ClearRealmCacheResponse clearRealmCache(ClearRealmCacheRequest request,
                                               RequestOptions options)
                                        throws IOException

Clears the cache in one or more realms. See the docs for more.

Parameters:

request - the request with the realm names and usernames to clear the cache for

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the clear realm cache call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

clearRealmCacheAsync

public Cancellable clearRealmCacheAsync(ClearRealmCacheRequest request,
                                        RequestOptions options,
                                        ActionListener<ClearRealmCacheResponse> listener)

Clears the cache in one or more realms asynchronously. See the docs for more.

Parameters:

request - the request with the realm names and usernames to clear the cache for

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

clearRolesCache

public ClearRolesCacheResponse clearRolesCache(ClearRolesCacheRequest request,
                                               RequestOptions options)
                                        throws IOException

Clears the roles cache for a set of roles. See the docs for more.

Parameters:

request - the request with the roles for which the cache should be cleared.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the clear roles cache call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

clearRolesCacheAsync

public Cancellable clearRolesCacheAsync(ClearRolesCacheRequest request,
                                        RequestOptions options,
                                        ActionListener<ClearRolesCacheResponse> listener)

Clears the roles cache for a set of roles asynchronously. See the docs for more.

Parameters:

request - the request with the roles for which the cache should be cleared.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getSslCertificates

public GetSslCertificatesResponse getSslCertificates(RequestOptions options)
                                              throws IOException

Synchronously retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get certificates call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getSslCertificatesAsync

public Cancellable getSslCertificatesAsync(RequestOptions options,
                                           ActionListener<GetSslCertificatesResponse> listener)

Asynchronously retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

changePassword

public boolean changePassword(ChangePasswordRequest request,
                              RequestOptions options)
                       throws IOException

Change the password of a user of a native realm or built-in user synchronously. See the docs for more.

Parameters:

request - the request with the user's new password

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if the request succeeded (the new password was set)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

changePassword

@Deprecated
public boolean changePassword(RequestOptions options,
                              ChangePasswordRequest request)
                       throws IOException

Deprecated.

use changePassword(ChangePasswordRequest, RequestOptions) instead

Change the password of a user of a native realm or built-in user synchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user's new password

Returns:

true if the request succeeded (the new password was set)

Throws:

IOException - in case there is a problem sending the request or parsing back the response

changePasswordAsync

public Cancellable changePasswordAsync(ChangePasswordRequest request,
                                       RequestOptions options,
                                       ActionListener<Boolean> listener)

Change the password of a user of a native realm or built-in user asynchronously. See the docs for more.

Parameters:

request - the request with the user's new password

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

changePasswordAsync

@Deprecated
public Cancellable changePasswordAsync(RequestOptions options,
                                       ChangePasswordRequest request,
                                       ActionListener<Boolean> listener)

Deprecated.

use changePasswordAsync(ChangePasswordRequest, RequestOptions, ActionListener) instead

Change the password of a user of a native realm or built-in user asynchronously. See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

request - the request with the user's new password

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteRoleMapping

public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request,
                                                   RequestOptions options)
                                            throws IOException

Delete a role mapping. See the docs for more.

Parameters:

request - the request with the role mapping name to be deleted.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the delete role mapping call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getRolesAsync

public Cancellable getRolesAsync(GetRolesRequest request,
                                 RequestOptions options,
                                 ActionListener<GetRolesResponse> listener)

Asynchronously retrieves roles from the native roles store. See the docs for more.

Parameters:

request - the request with the roles to get

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getRoles

public GetRolesResponse getRoles(GetRolesRequest request,
                                 RequestOptions options)
                          throws IOException

Retrieves roles from the native roles store. See the docs for more.

Parameters:

request - the request with the roles to get

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get roles call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

putRoleAsync

public Cancellable putRoleAsync(PutRoleRequest request,
                                RequestOptions options,
                                ActionListener<PutRoleResponse> listener)

Asynchronously creates or updates a role in the native roles store. See the docs for more.

Parameters:

request - the request containing the role to create or update

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

putRole

public PutRoleResponse putRole(PutRoleRequest request,
                               RequestOptions options)
                        throws IOException

Create or update a role in the native roles store. See the docs for more.

Parameters:

request - the request containing the role to create or update

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the put role call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deleteRoleMappingAsync

public Cancellable deleteRoleMappingAsync(DeleteRoleMappingRequest request,
                                          RequestOptions options,
                                          ActionListener<DeleteRoleMappingResponse> listener)

Asynchronously delete a role mapping. See the docs for more.

Parameters:

request - the request with the role mapping name to be deleted.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteRole

public DeleteRoleResponse deleteRole(DeleteRoleRequest request,
                                     RequestOptions options)
                              throws IOException

Removes role from the native realm. See the docs for more.

Parameters:

request - the request with the role to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the delete role call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deleteRoleAsync

public Cancellable deleteRoleAsync(DeleteRoleRequest request,
                                   RequestOptions options,
                                   ActionListener<DeleteRoleResponse> listener)

Removes role from the native realm. See the docs for more.

Parameters:

request - the request with the role to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

createToken

public CreateTokenResponse createToken(CreateTokenRequest request,
                                       RequestOptions options)
                                throws IOException

Creates an OAuth2 token. See the docs for more.

Parameters:

request - the request for the token

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the create token call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

createTokenAsync

public Cancellable createTokenAsync(CreateTokenRequest request,
                                    RequestOptions options,
                                    ActionListener<CreateTokenResponse> listener)

Asynchronously creates an OAuth2 token. See the docs for more.

Parameters:

request - the request for the token

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

invalidateToken

public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request,
                                               RequestOptions options)
                                        throws IOException

Invalidates an OAuth2 token. See the docs for more.

Parameters:

request - the request to invalidate the token

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the create token call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

invalidateTokenAsync

public Cancellable invalidateTokenAsync(InvalidateTokenRequest request,
                                        RequestOptions options,
                                        ActionListener<InvalidateTokenResponse> listener)

Asynchronously invalidates an OAuth2 token. See the docs for more.

Parameters:

request - the request to invalidate the token

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getBuiltinPrivileges

public GetBuiltinPrivilegesResponse getBuiltinPrivileges(RequestOptions options)
                                                  throws IOException

Synchronously get builtin (cluster & index) privilege(s). See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get builtin privileges call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getBuiltinPrivilegesAsync

public Cancellable getBuiltinPrivilegesAsync(RequestOptions options,
                                             ActionListener<GetBuiltinPrivilegesResponse> listener)

Asynchronously get builtin (cluster & index) privilege(s). See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getPrivileges

public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request,
                                           RequestOptions options)
                                    throws IOException

Synchronously get application privilege(s). See the docs for more.

Parameters:

request - GetPrivilegesRequest with the application name and the privilege name. If no application name is provided, information about all privileges for all applications is retrieved. If no privilege name is provided, information about all privileges of the specified application is retrieved.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the get privileges call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getPrivilegesAsync

public Cancellable getPrivilegesAsync(GetPrivilegesRequest request,
                                      RequestOptions options,
                                      ActionListener<GetPrivilegesResponse> listener)

Asynchronously get application privilege(s). See the docs for more.

Parameters:

request - GetPrivilegesRequest with the application name and the privilege name. If no application name is provided, information about all privileges for all applications is retrieved. If no privilege name is provided, information about all privileges of the specified application is retrieved.

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

putPrivileges

public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request,
                                           RequestOptions options)
                                    throws IOException

Create or update application privileges. See the docs for more.

Parameters:

request - the request to create or update application privileges

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the create or update application privileges call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

putPrivilegesAsync

public Cancellable putPrivilegesAsync(PutPrivilegesRequest request,
                                      RequestOptions options,
                                      ActionListener<PutPrivilegesResponse> listener)

Asynchronously create or update application privileges.
See the docs for more.

Parameters:

request - the request to create or update application privileges

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deletePrivileges

public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request,
                                                 RequestOptions options)
                                          throws IOException

Removes application privilege(s) See the docs for more.

Parameters:

request - the request with the application privilege to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the delete application privilege call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deletePrivilegesAsync

public Cancellable deletePrivilegesAsync(DeletePrivilegesRequest request,
                                         RequestOptions options,
                                         ActionListener<DeletePrivilegesResponse> listener)

Asynchronously removes an application privilege See the docs for more.

Parameters:

request - the request with the application privilege to delete

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

createApiKey

public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request,
                                         RequestOptions options)
                                  throws IOException

Create an API Key.
See the docs for more.

Parameters:

request - the request to create a API key

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the create API key call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

createApiKeyAsync

public Cancellable createApiKeyAsync(CreateApiKeyRequest request,
                                     RequestOptions options,
                                     ActionListener<CreateApiKeyResponse> listener)

Asynchronously creates an API key.
See the docs for more.

Parameters:

request - the request to create a API key

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getApiKey

public GetApiKeyResponse getApiKey(GetApiKeyRequest request,
                                   RequestOptions options)
                            throws IOException

Retrieve API Key(s) information.
See the docs for more.

Parameters:

request - the request to retrieve API key(s)

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the create API key call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getApiKeyAsync

public Cancellable getApiKeyAsync(GetApiKeyRequest request,
                                  RequestOptions options,
                                  ActionListener<GetApiKeyResponse> listener)

Asynchronously retrieve API Key(s) information.
See the docs for more.

Parameters:

request - the request to retrieve API key(s)

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

invalidateApiKey

public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request,
                                                 RequestOptions options)
                                          throws IOException

Invalidate API Key(s).
See the docs for more.

Parameters:

request - the request to invalidate API key(s)

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the invalidate API key call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

invalidateApiKeyAsync

public Cancellable invalidateApiKeyAsync(InvalidateApiKeyRequest request,
                                         RequestOptions options,
                                         ActionListener<InvalidateApiKeyResponse> listener)

Asynchronously invalidates API key(s).
See the docs for more.

Parameters:

request - the request to invalidate API key(s)

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

delegatePkiAuthentication

public DelegatePkiAuthenticationResponse delegatePkiAuthentication(DelegatePkiAuthenticationRequest request,
                                                                   RequestOptions options)
                                                            throws IOException

Get an Elasticsearch access token from an X509Certificate chain. The certificate chain is that of the client from a mutually authenticated TLS session, and it is validated by the PKI realms with delegation.enabled toggled to true.
See the docs for more details.

Parameters:

request - the request containing the certificate chain

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response from the delegate-pki-authentication API key call

Throws:

IOException - in case there is a problem sending the request or parsing back the response

delegatePkiAuthenticationAsync

public Cancellable delegatePkiAuthenticationAsync(DelegatePkiAuthenticationRequest request,
                                                  RequestOptions options,
                                                  ActionListener<DelegatePkiAuthenticationResponse> listener)

Asynchronously get an Elasticsearch access token from an X509Certificate chain. The certificate chain is that of the client from a mutually authenticated TLS session, and it is validated by the PKI realms with delegation.enabled toggled to true.
See the docs for more details.

Parameters:

request - the request containing the certificate chain

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion