Package co.elastic.clients.elasticsearch.security

Class ElasticsearchSecurityClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>

co.elastic.clients.elasticsearch.security.ElasticsearchSecurityClient

public class ElasticsearchSecurityClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>

Client for the security namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSecurityClient(ElasticsearchTransport transport)
ElasticsearchSecurityClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
ActivateUserProfileResponse	activateUserProfile(ActivateUserProfileRequest request)	Creates or updates a user profile on behalf of another user.
final ActivateUserProfileResponse	activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)	Creates or updates a user profile on behalf of another user.
AuthenticateResponse	authenticate()	Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.
BulkDeleteRoleResponse	bulkDeleteRole(BulkDeleteRoleRequest request)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
final BulkDeleteRoleResponse	bulkDeleteRole(Function<BulkDeleteRoleRequest.Builder,ObjectBuilder<BulkDeleteRoleRequest>> fn)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
BulkPutRoleResponse	bulkPutRole(BulkPutRoleRequest request)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
final BulkPutRoleResponse	bulkPutRole(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
ChangePasswordResponse	changePassword()	Changes the passwords of users in the native realm and built-in users.
ChangePasswordResponse	changePassword(ChangePasswordRequest request)	Changes the passwords of users in the native realm and built-in users.
final ChangePasswordResponse	changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)	Changes the passwords of users in the native realm and built-in users.
ClearApiKeyCacheResponse	clearApiKeyCache(ClearApiKeyCacheRequest request)	Evicts a subset of all entries from the API key cache.
final ClearApiKeyCacheResponse	clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)	Evicts a subset of all entries from the API key cache.
ClearCachedPrivilegesResponse	clearCachedPrivileges(ClearCachedPrivilegesRequest request)	Evicts application privileges from the native application privileges cache.
final ClearCachedPrivilegesResponse	clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)	Evicts application privileges from the native application privileges cache.
ClearCachedRealmsResponse	clearCachedRealms(ClearCachedRealmsRequest request)	Evicts users from the user cache.
final ClearCachedRealmsResponse	clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)	Evicts users from the user cache.
ClearCachedRolesResponse	clearCachedRoles(ClearCachedRolesRequest request)	Evicts roles from the native role cache.
final ClearCachedRolesResponse	clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)	Evicts roles from the native role cache.
ClearCachedServiceTokensResponse	clearCachedServiceTokens(ClearCachedServiceTokensRequest request)	Evicts tokens from the service account token caches.
final ClearCachedServiceTokensResponse	clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)	Evicts tokens from the service account token caches.
CreateApiKeyResponse	createApiKey()	Creates an API key for access without requiring basic authentication.
CreateApiKeyResponse	createApiKey(CreateApiKeyRequest request)	Creates an API key for access without requiring basic authentication.
final CreateApiKeyResponse	createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)	Creates an API key for access without requiring basic authentication.
CreateServiceTokenResponse	createServiceToken(CreateServiceTokenRequest request)	Creates a service accounts token for access without requiring basic authentication.
final CreateServiceTokenResponse	createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)	Creates a service accounts token for access without requiring basic authentication.
DeletePrivilegesResponse	deletePrivileges(DeletePrivilegesRequest request)	Removes application privileges.
final DeletePrivilegesResponse	deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)	Removes application privileges.
DeleteRoleResponse	deleteRole(DeleteRoleRequest request)	Removes roles in the native realm.
final DeleteRoleResponse	deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)	Removes roles in the native realm.
DeleteRoleMappingResponse	deleteRoleMapping(DeleteRoleMappingRequest request)	Removes role mappings.
final DeleteRoleMappingResponse	deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)	Removes role mappings.
DeleteServiceTokenResponse	deleteServiceToken(DeleteServiceTokenRequest request)	Deletes a service account token.
final DeleteServiceTokenResponse	deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)	Deletes a service account token.
DeleteUserResponse	deleteUser(DeleteUserRequest request)	Deletes users from the native realm.
final DeleteUserResponse	deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)	Deletes users from the native realm.
DisableUserResponse	disableUser(DisableUserRequest request)	Disables users in the native realm.
final DisableUserResponse	disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)	Disables users in the native realm.
DisableUserProfileResponse	disableUserProfile(DisableUserProfileRequest request)	Disables a user profile so it's not visible in user profile searches.
final DisableUserProfileResponse	disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)	Disables a user profile so it's not visible in user profile searches.
EnableUserResponse	enableUser(EnableUserRequest request)	Enables users in the native realm.
final EnableUserResponse	enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)	Enables users in the native realm.
EnableUserProfileResponse	enableUserProfile(EnableUserProfileRequest request)	Enables a user profile so it's visible in user profile searches.
final EnableUserProfileResponse	enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)	Enables a user profile so it's visible in user profile searches.
EnrollKibanaResponse	enrollKibana()	Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
EnrollNodeResponse	enrollNode()	Allows a new node to join an existing cluster with security features enabled.
GetApiKeyResponse	getApiKey()	Retrieves information for one or more API keys.
GetApiKeyResponse	getApiKey(GetApiKeyRequest request)	Retrieves information for one or more API keys.
final GetApiKeyResponse	getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)	Retrieves information for one or more API keys.
GetBuiltinPrivilegesResponse	getBuiltinPrivileges()	Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
GetPrivilegesResponse	getPrivileges()	Retrieves application privileges.
GetPrivilegesResponse	getPrivileges(GetPrivilegesRequest request)	Retrieves application privileges.
final GetPrivilegesResponse	getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)	Retrieves application privileges.
GetRoleResponse	getRole()	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
GetRoleResponse	getRole(GetRoleRequest request)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
final GetRoleResponse	getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
GetRoleMappingResponse	getRoleMapping()	Retrieves role mappings.
GetRoleMappingResponse	getRoleMapping(GetRoleMappingRequest request)	Retrieves role mappings.
final GetRoleMappingResponse	getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)	Retrieves role mappings.
GetServiceAccountsResponse	getServiceAccounts()	This API returns a list of service accounts that match the provided path parameter(s).
GetServiceAccountsResponse	getServiceAccounts(GetServiceAccountsRequest request)	This API returns a list of service accounts that match the provided path parameter(s).
final GetServiceAccountsResponse	getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)	This API returns a list of service accounts that match the provided path parameter(s).
GetServiceCredentialsResponse	getServiceCredentials(GetServiceCredentialsRequest request)	Retrieves information of all service credentials for a service account.
final GetServiceCredentialsResponse	getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)	Retrieves information of all service credentials for a service account.
GetTokenResponse	getToken()	Creates a bearer token for access without requiring basic authentication.
GetTokenResponse	getToken(GetTokenRequest request)	Creates a bearer token for access without requiring basic authentication.
final GetTokenResponse	getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)	Creates a bearer token for access without requiring basic authentication.
GetUserResponse	getUser()	Retrieves information about users in the native realm and built-in users.
GetUserResponse	getUser(GetUserRequest request)	Retrieves information about users in the native realm and built-in users.
final GetUserResponse	getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)	Retrieves information about users in the native realm and built-in users.
GetUserPrivilegesResponse	getUserPrivileges()	Retrieves security privileges for the logged in user.
GetUserPrivilegesResponse	getUserPrivileges(GetUserPrivilegesRequest request)	Retrieves security privileges for the logged in user.
final GetUserPrivilegesResponse	getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)	Retrieves security privileges for the logged in user.
GetUserProfileResponse	getUserProfile(GetUserProfileRequest request)	Retrieves a user's profile using the unique profile ID.
final GetUserProfileResponse	getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)	Retrieves a user's profile using the unique profile ID.
GrantApiKeyResponse	grantApiKey(GrantApiKeyRequest request)	Creates an API key on behalf of another user.
final GrantApiKeyResponse	grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)	Creates an API key on behalf of another user.
HasPrivilegesResponse	hasPrivileges()	Determines whether the specified user has a specified list of privileges.
HasPrivilegesResponse	hasPrivileges(HasPrivilegesRequest request)	Determines whether the specified user has a specified list of privileges.
final HasPrivilegesResponse	hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)	Determines whether the specified user has a specified list of privileges.
HasPrivilegesUserProfileResponse	hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request)	Determines whether the users associated with the specified profile IDs have all the requested privileges.
final HasPrivilegesUserProfileResponse	hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)	Determines whether the users associated with the specified profile IDs have all the requested privileges.
InvalidateApiKeyResponse	invalidateApiKey()	Invalidates one or more API keys.
InvalidateApiKeyResponse	invalidateApiKey(InvalidateApiKeyRequest request)	Invalidates one or more API keys.
final InvalidateApiKeyResponse	invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)	Invalidates one or more API keys.
InvalidateTokenResponse	invalidateToken()	Invalidates one or more access tokens or refresh tokens.
InvalidateTokenResponse	invalidateToken(InvalidateTokenRequest request)	Invalidates one or more access tokens or refresh tokens.
final InvalidateTokenResponse	invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)	Invalidates one or more access tokens or refresh tokens.
PutPrivilegesResponse	putPrivileges()	Adds or updates application privileges.
PutPrivilegesResponse	putPrivileges(PutPrivilegesRequest request)	Adds or updates application privileges.
final PutPrivilegesResponse	putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)	Adds or updates application privileges.
PutRoleResponse	putRole(PutRoleRequest request)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
final PutRoleResponse	putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)	The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
PutRoleMappingResponse	putRoleMapping(PutRoleMappingRequest request)	Creates and updates role mappings.
final PutRoleMappingResponse	putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)	Creates and updates role mappings.
PutUserResponse	putUser(PutUserRequest request)	Adds and updates users in the native realm.
final PutUserResponse	putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)	Adds and updates users in the native realm.
QueryApiKeysResponse	queryApiKeys()	Retrieves information for API keys in a paginated manner.
QueryApiKeysResponse	queryApiKeys(QueryApiKeysRequest request)	Retrieves information for API keys in a paginated manner.
final QueryApiKeysResponse	queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)	Retrieves information for API keys in a paginated manner.
QueryRoleResponse	queryRole()	Retrieves roles in a paginated manner.
QueryRoleResponse	queryRole(QueryRoleRequest request)	Retrieves roles in a paginated manner.
final QueryRoleResponse	queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn)	Retrieves roles in a paginated manner.
QueryUserResponse	queryUser()	Retrieves information for Users in a paginated manner.
QueryUserResponse	queryUser(QueryUserRequest request)	Retrieves information for Users in a paginated manner.
final QueryUserResponse	queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)	Retrieves information for Users in a paginated manner.
SamlAuthenticateResponse	samlAuthenticate(SamlAuthenticateRequest request)	Submits a SAML Response message to Elasticsearch for consumption.
final SamlAuthenticateResponse	samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)	Submits a SAML Response message to Elasticsearch for consumption.
BooleanResponse	samlCompleteLogout(SamlCompleteLogoutRequest request)	Verifies the logout response sent from the SAML IdP.
final BooleanResponse	samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)	Verifies the logout response sent from the SAML IdP.
SamlInvalidateResponse	samlInvalidate(SamlInvalidateRequest request)	Submits a SAML LogoutRequest message to Elasticsearch for consumption.
final SamlInvalidateResponse	samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn)	Submits a SAML LogoutRequest message to Elasticsearch for consumption.
SamlLogoutResponse	samlLogout(SamlLogoutRequest request)	Submits a request to invalidate an access token and refresh token.
final SamlLogoutResponse	samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)	Submits a request to invalidate an access token and refresh token.
SamlPrepareAuthenticationResponse	samlPrepareAuthentication()	Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
SamlPrepareAuthenticationResponse	samlPrepareAuthentication(SamlPrepareAuthenticationRequest request)	Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
final SamlPrepareAuthenticationResponse	samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)	Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
SamlServiceProviderMetadataResponse	samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request)	Generate SAML metadata for a SAML 2.0 Service Provider.
final SamlServiceProviderMetadataResponse	samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)	Generate SAML metadata for a SAML 2.0 Service Provider.
SuggestUserProfilesResponse	suggestUserProfiles()	Get suggestions for user profiles that match specified search criteria.
SuggestUserProfilesResponse	suggestUserProfiles(SuggestUserProfilesRequest request)	Get suggestions for user profiles that match specified search criteria.
final SuggestUserProfilesResponse	suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)	Get suggestions for user profiles that match specified search criteria.
UpdateApiKeyResponse	updateApiKey(UpdateApiKeyRequest request)	Updates attributes of an existing API key.
final UpdateApiKeyResponse	updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)	Updates attributes of an existing API key.
UpdateUserProfileDataResponse	updateUserProfileData(UpdateUserProfileDataRequest request)	Updates specific data for the user profile that's associated with the specified unique ID.
final UpdateUserProfileDataResponse	updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)	Updates specific data for the user profile that's associated with the specified unique ID.
ElasticsearchSecurityClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSecurityClient

public ElasticsearchSecurityClient(ElasticsearchTransport transport)

ElasticsearchSecurityClient

public ElasticsearchSecurityClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchSecurityClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>

activateUserProfile

public ActivateUserProfileResponse activateUserProfile(ActivateUserProfileRequest request)
                                                throws IOException,
ElasticsearchException

Creates or updates a user profile on behalf of another user.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

activateUserProfile

public final ActivateUserProfileResponse activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Creates or updates a user profile on behalf of another user.

Parameters:

fn - a function that initializes a builder to create the ActivateUserProfileRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

authenticate

public AuthenticateResponse authenticate()
                                  throws IOException,
ElasticsearchException

Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulkDeleteRole

public BulkDeleteRoleResponse bulkDeleteRole(BulkDeleteRoleRequest request)
                                      throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulkDeleteRole

public final BulkDeleteRoleResponse bulkDeleteRole(Function<BulkDeleteRoleRequest.Builder,ObjectBuilder<BulkDeleteRoleRequest>> fn)
                                            throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files.

Parameters:

fn - a function that initializes a builder to create the BulkDeleteRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulkPutRole

public BulkPutRoleResponse bulkPutRole(BulkPutRoleRequest request)
                                throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

bulkPutRole

public final BulkPutRoleResponse bulkPutRole(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn)
                                      throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.

Parameters:

fn - a function that initializes a builder to create the BulkPutRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

changePassword

public ChangePasswordResponse changePassword(ChangePasswordRequest request)
                                      throws IOException,
ElasticsearchException

Changes the passwords of users in the native realm and built-in users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

changePassword

public final ChangePasswordResponse changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)
                                            throws IOException,
ElasticsearchException

Changes the passwords of users in the native realm and built-in users.

Parameters:

fn - a function that initializes a builder to create the ChangePasswordRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

changePassword

public ChangePasswordResponse changePassword()
                                      throws IOException,
ElasticsearchException

Changes the passwords of users in the native realm and built-in users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearApiKeyCache

public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request)
                                          throws IOException,
ElasticsearchException

Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearApiKeyCache

public final ClearApiKeyCacheResponse clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)
                                                throws IOException,
ElasticsearchException

Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.

Parameters:

fn - a function that initializes a builder to create the ClearApiKeyCacheRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivilegesRequest request)
                                                    throws IOException,
ElasticsearchException

Evicts application privileges from the native application privileges cache.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public final ClearCachedPrivilegesResponse clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Evicts application privileges from the native application privileges cache.

Parameters:

fn - a function that initializes a builder to create the ClearCachedPrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedRealms

public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest request)
                                            throws IOException,
ElasticsearchException

Evicts users from the user cache. Can completely clear the cache or evict specific users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedRealms

public final ClearCachedRealmsResponse clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Evicts users from the user cache. Can completely clear the cache or evict specific users.

Parameters:

fn - a function that initializes a builder to create the ClearCachedRealmsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedRoles

public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request)
                                          throws IOException,
ElasticsearchException

Evicts roles from the native role cache.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedRoles

public final ClearCachedRolesResponse clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)
                                                throws IOException,
ElasticsearchException

Evicts roles from the native role cache.

Parameters:

fn - a function that initializes a builder to create the ClearCachedRolesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServiceTokensRequest request)
                                                          throws IOException,
ElasticsearchException

Evicts tokens from the service account token caches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public final ClearCachedServiceTokensResponse clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)
                                                                throws IOException,
ElasticsearchException

Evicts tokens from the service account token caches.

Parameters:

fn - a function that initializes a builder to create the ClearCachedServiceTokensRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createApiKey

public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request)
                                  throws IOException,
ElasticsearchException

Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createApiKey

public final CreateApiKeyResponse createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)
                                        throws IOException,
ElasticsearchException

Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.

Parameters:

fn - a function that initializes a builder to create the CreateApiKeyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createApiKey

public CreateApiKeyResponse createApiKey()
                                  throws IOException,
ElasticsearchException

Creates an API key for access without requiring basic authentication. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createServiceToken

public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest request)
                                              throws IOException,
ElasticsearchException

Creates a service accounts token for access without requiring basic authentication.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

createServiceToken

public final CreateServiceTokenResponse createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Creates a service accounts token for access without requiring basic authentication.

Parameters:

fn - a function that initializes a builder to create the CreateServiceTokenRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePrivileges

public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request)
                                          throws IOException,
ElasticsearchException

Removes application privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deletePrivileges

public final DeletePrivilegesResponse deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)
                                                throws IOException,
ElasticsearchException

Removes application privileges.

Parameters:

fn - a function that initializes a builder to create the DeletePrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRole

public DeleteRoleResponse deleteRole(DeleteRoleRequest request)
                              throws IOException,
ElasticsearchException

Removes roles in the native realm.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRole

public final DeleteRoleResponse deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)
                                    throws IOException,
ElasticsearchException

Removes roles in the native realm.

Parameters:

fn - a function that initializes a builder to create the DeleteRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRoleMapping

public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request)
                                            throws IOException,
ElasticsearchException

Removes role mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteRoleMapping

public final DeleteRoleMappingResponse deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Removes role mappings.

Parameters:

fn - a function that initializes a builder to create the DeleteRoleMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteServiceToken

public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest request)
                                              throws IOException,
ElasticsearchException

Deletes a service account token.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteServiceToken

public final DeleteServiceTokenResponse deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Deletes a service account token.

Parameters:

fn - a function that initializes a builder to create the DeleteServiceTokenRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteUser

public DeleteUserResponse deleteUser(DeleteUserRequest request)
                              throws IOException,
ElasticsearchException

Deletes users from the native realm.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteUser

public final DeleteUserResponse deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)
                                    throws IOException,
ElasticsearchException

Deletes users from the native realm.

Parameters:

fn - a function that initializes a builder to create the DeleteUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

disableUser

public DisableUserResponse disableUser(DisableUserRequest request)
                                throws IOException,
ElasticsearchException

Disables users in the native realm.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

disableUser

public final DisableUserResponse disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)
                                      throws IOException,
ElasticsearchException

Disables users in the native realm.

Parameters:

fn - a function that initializes a builder to create the DisableUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

disableUserProfile

public DisableUserProfileResponse disableUserProfile(DisableUserProfileRequest request)
                                              throws IOException,
ElasticsearchException

Disables a user profile so it's not visible in user profile searches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

disableUserProfile

public final DisableUserProfileResponse disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)
                                                    throws IOException,
ElasticsearchException

Disables a user profile so it's not visible in user profile searches.

Parameters:

fn - a function that initializes a builder to create the DisableUserProfileRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enableUser

public EnableUserResponse enableUser(EnableUserRequest request)
                              throws IOException,
ElasticsearchException

Enables users in the native realm.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enableUser

public final EnableUserResponse enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)
                                    throws IOException,
ElasticsearchException

Enables users in the native realm.

Parameters:

fn - a function that initializes a builder to create the EnableUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enableUserProfile

public EnableUserProfileResponse enableUserProfile(EnableUserProfileRequest request)
                                            throws IOException,
ElasticsearchException

Enables a user profile so it's visible in user profile searches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enableUserProfile

public final EnableUserProfileResponse enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Enables a user profile so it's visible in user profile searches.

Parameters:

fn - a function that initializes a builder to create the EnableUserProfileRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enrollKibana

public EnrollKibanaResponse enrollKibana()
                                  throws IOException,
ElasticsearchException

Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

enrollNode

public EnrollNodeResponse enrollNode()
                              throws IOException,
ElasticsearchException

Allows a new node to join an existing cluster with security features enabled.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getApiKey

public GetApiKeyResponse getApiKey(GetApiKeyRequest request)
                            throws IOException,
ElasticsearchException

Retrieves information for one or more API keys. NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getApiKey

public final GetApiKeyResponse getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)
                                  throws IOException,
ElasticsearchException

Retrieves information for one or more API keys. NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

Parameters:

fn - a function that initializes a builder to create the GetApiKeyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getApiKey

public GetApiKeyResponse getApiKey()
                            throws IOException,
ElasticsearchException

Retrieves information for one or more API keys. NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getBuiltinPrivileges

public GetBuiltinPrivilegesResponse getBuiltinPrivileges()
                                                  throws IOException,
ElasticsearchException

Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPrivileges

public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request)
                                    throws IOException,
ElasticsearchException

Retrieves application privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPrivileges

public final GetPrivilegesResponse getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)
                                          throws IOException,
ElasticsearchException

Retrieves application privileges.

Parameters:

fn - a function that initializes a builder to create the GetPrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getPrivileges

public GetPrivilegesResponse getPrivileges()
                                    throws IOException,
ElasticsearchException

Retrieves application privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRole

public GetRoleResponse getRole(GetRoleRequest request)
                        throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRole

public final GetRoleResponse getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)
                              throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

Parameters:

fn - a function that initializes a builder to create the GetRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRole

public GetRoleResponse getRole()
                        throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRoleMapping

public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request)
                                      throws IOException,
ElasticsearchException

Retrieves role mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRoleMapping

public final GetRoleMappingResponse getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)
                                            throws IOException,
ElasticsearchException

Retrieves role mappings.

Parameters:

fn - a function that initializes a builder to create the GetRoleMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getRoleMapping

public GetRoleMappingResponse getRoleMapping()
                                      throws IOException,
ElasticsearchException

Retrieves role mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getServiceAccounts

public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest request)
                                              throws IOException,
ElasticsearchException

This API returns a list of service accounts that match the provided path parameter(s).

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getServiceAccounts

public final GetServiceAccountsResponse getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)
                                                    throws IOException,
ElasticsearchException

This API returns a list of service accounts that match the provided path parameter(s).

Parameters:

fn - a function that initializes a builder to create the GetServiceAccountsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getServiceAccounts

public GetServiceAccountsResponse getServiceAccounts()
                                              throws IOException,
ElasticsearchException

This API returns a list of service accounts that match the provided path parameter(s).

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getServiceCredentials

public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentialsRequest request)
                                                    throws IOException,
ElasticsearchException

Retrieves information of all service credentials for a service account.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getServiceCredentials

public final GetServiceCredentialsResponse getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Retrieves information of all service credentials for a service account.

Parameters:

fn - a function that initializes a builder to create the GetServiceCredentialsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getToken

public GetTokenResponse getToken(GetTokenRequest request)
                          throws IOException,
ElasticsearchException

Creates a bearer token for access without requiring basic authentication.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getToken

public final GetTokenResponse getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)
                                throws IOException,
ElasticsearchException

Creates a bearer token for access without requiring basic authentication.

Parameters:

fn - a function that initializes a builder to create the GetTokenRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getToken

public GetTokenResponse getToken()
                          throws IOException,
ElasticsearchException

Creates a bearer token for access without requiring basic authentication.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUser

public GetUserResponse getUser(GetUserRequest request)
                        throws IOException,
ElasticsearchException

Retrieves information about users in the native realm and built-in users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUser

public final GetUserResponse getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)
                              throws IOException,
ElasticsearchException

Retrieves information about users in the native realm and built-in users.

Parameters:

fn - a function that initializes a builder to create the GetUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUser

public GetUserResponse getUser()
                        throws IOException,
ElasticsearchException

Retrieves information about users in the native realm and built-in users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUserPrivileges

public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest request)
                                            throws IOException,
ElasticsearchException

Retrieves security privileges for the logged in user.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUserPrivileges

public final GetUserPrivilegesResponse getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Retrieves security privileges for the logged in user.

Parameters:

fn - a function that initializes a builder to create the GetUserPrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUserPrivileges

public GetUserPrivilegesResponse getUserPrivileges()
                                            throws IOException,
ElasticsearchException

Retrieves security privileges for the logged in user.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUserProfile

public GetUserProfileResponse getUserProfile(GetUserProfileRequest request)
                                      throws IOException,
ElasticsearchException

Retrieves a user's profile using the unique profile ID.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getUserProfile

public final GetUserProfileResponse getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)
                                            throws IOException,
ElasticsearchException

Retrieves a user's profile using the unique profile ID.

Parameters:

fn - a function that initializes a builder to create the GetUserProfileRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

grantApiKey

public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request)
                                throws IOException,
ElasticsearchException

Creates an API key on behalf of another user. This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user.

This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.

A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

grantApiKey

public final GrantApiKeyResponse grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)
                                      throws IOException,
ElasticsearchException

Creates an API key on behalf of another user. This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user.

This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.

A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys.

Parameters:

fn - a function that initializes a builder to create the GrantApiKeyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hasPrivileges

public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request)
                                    throws IOException,
ElasticsearchException

Determines whether the specified user has a specified list of privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hasPrivileges

public final HasPrivilegesResponse hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)
                                          throws IOException,
ElasticsearchException

Determines whether the specified user has a specified list of privileges.

Parameters:

fn - a function that initializes a builder to create the HasPrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hasPrivileges

public HasPrivilegesResponse hasPrivileges()
                                    throws IOException,
ElasticsearchException

Determines whether the specified user has a specified list of privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hasPrivilegesUserProfile

public HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request)
                                                          throws IOException,
ElasticsearchException

Determines whether the users associated with the specified profile IDs have all the requested privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

hasPrivilegesUserProfile

public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)
                                                                throws IOException,
ElasticsearchException

Determines whether the users associated with the specified profile IDs have all the requested privileges.

Parameters:

fn - a function that initializes a builder to create the HasPrivilegesUserProfileRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateApiKey

public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request)
                                          throws IOException,
ElasticsearchException

Invalidates one or more API keys. The manage_api_key privilege allows deleting any API keys. The manage_own_api_key only allows deleting API keys that are owned by the user. In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats:

• Set the parameter owner=true.
• Or, set both username and realm_name to match the user’s identity.
• Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateApiKey

public final InvalidateApiKeyResponse invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)
                                                throws IOException,
ElasticsearchException

Invalidates one or more API keys. The manage_api_key privilege allows deleting any API keys. The manage_own_api_key only allows deleting API keys that are owned by the user. In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats:

• Set the parameter owner=true.
• Or, set both username and realm_name to match the user’s identity.
• Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field.

Parameters:

fn - a function that initializes a builder to create the InvalidateApiKeyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateApiKey

public InvalidateApiKeyResponse invalidateApiKey()
                                          throws IOException,
ElasticsearchException

Invalidates one or more API keys. The manage_api_key privilege allows deleting any API keys. The manage_own_api_key only allows deleting API keys that are owned by the user. In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats:

• Set the parameter owner=true.
• Or, set both username and realm_name to match the user’s identity.
• Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateToken

public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request)
                                        throws IOException,
ElasticsearchException

Invalidates one or more access tokens or refresh tokens.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateToken

public final InvalidateTokenResponse invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)
                                              throws IOException,
ElasticsearchException

Invalidates one or more access tokens or refresh tokens.

Parameters:

fn - a function that initializes a builder to create the InvalidateTokenRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

invalidateToken

public InvalidateTokenResponse invalidateToken()
                                        throws IOException,
ElasticsearchException

Invalidates one or more access tokens or refresh tokens.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPrivileges

public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request)
                                    throws IOException,
ElasticsearchException

Adds or updates application privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPrivileges

public final PutPrivilegesResponse putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)
                                          throws IOException,
ElasticsearchException

Adds or updates application privileges.

Parameters:

fn - a function that initializes a builder to create the PutPrivilegesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putPrivileges

public PutPrivilegesResponse putPrivileges()
                                    throws IOException,
ElasticsearchException

Adds or updates application privileges.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRole

public PutRoleResponse putRole(PutRoleRequest request)
                        throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRole

public final PutRoleResponse putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)
                              throws IOException,
ElasticsearchException

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.

Parameters:

fn - a function that initializes a builder to create the PutRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRoleMapping

public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request)
                                      throws IOException,
ElasticsearchException

Creates and updates role mappings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putRoleMapping

public final PutRoleMappingResponse putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)
                                            throws IOException,
ElasticsearchException

Creates and updates role mappings.

Parameters:

fn - a function that initializes a builder to create the PutRoleMappingRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putUser

public PutUserResponse putUser(PutUserRequest request)
                        throws IOException,
ElasticsearchException

Adds and updates users in the native realm. These users are commonly referred to as native users.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putUser

public final PutUserResponse putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)
                              throws IOException,
ElasticsearchException

Adds and updates users in the native realm. These users are commonly referred to as native users.

Parameters:

fn - a function that initializes a builder to create the PutUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryApiKeys

public QueryApiKeysResponse queryApiKeys(QueryApiKeysRequest request)
                                  throws IOException,
ElasticsearchException

Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryApiKeys

public final QueryApiKeysResponse queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)
                                        throws IOException,
ElasticsearchException

Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.

Parameters:

fn - a function that initializes a builder to create the QueryApiKeysRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryApiKeys

public QueryApiKeysResponse queryApiKeys()
                                  throws IOException,
ElasticsearchException

Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryRole

public QueryRoleResponse queryRole(QueryRoleRequest request)
                            throws IOException,
ElasticsearchException

Retrieves roles in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryRole

public final QueryRoleResponse queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn)
                                  throws IOException,
ElasticsearchException

Retrieves roles in a paginated manner. You can optionally filter the results with a query.

Parameters:

fn - a function that initializes a builder to create the QueryRoleRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryRole

public QueryRoleResponse queryRole()
                            throws IOException,
ElasticsearchException

Retrieves roles in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryUser

public QueryUserResponse queryUser(QueryUserRequest request)
                            throws IOException,
ElasticsearchException

Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryUser

public final QueryUserResponse queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)
                                  throws IOException,
ElasticsearchException

Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.

Parameters:

fn - a function that initializes a builder to create the QueryUserRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryUser

public QueryUserResponse queryUser()
                            throws IOException,
ElasticsearchException

Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlAuthenticate

public SamlAuthenticateResponse samlAuthenticate(SamlAuthenticateRequest request)
                                          throws IOException,
ElasticsearchException

Submits a SAML Response message to Elasticsearch for consumption.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlAuthenticate

public final SamlAuthenticateResponse samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)
                                                throws IOException,
ElasticsearchException

Submits a SAML Response message to Elasticsearch for consumption.

Parameters:

fn - a function that initializes a builder to create the SamlAuthenticateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlCompleteLogout

public BooleanResponse samlCompleteLogout(SamlCompleteLogoutRequest request)
                                   throws IOException,
ElasticsearchException

Verifies the logout response sent from the SAML IdP.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlCompleteLogout

public final BooleanResponse samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)
                                         throws IOException,
ElasticsearchException

Verifies the logout response sent from the SAML IdP.

Parameters:

fn - a function that initializes a builder to create the SamlCompleteLogoutRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlInvalidate

public SamlInvalidateResponse samlInvalidate(SamlInvalidateRequest request)
                                      throws IOException,
ElasticsearchException

Submits a SAML LogoutRequest message to Elasticsearch for consumption.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlInvalidate

public final SamlInvalidateResponse samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn)
                                            throws IOException,
ElasticsearchException

Submits a SAML LogoutRequest message to Elasticsearch for consumption.

Parameters:

fn - a function that initializes a builder to create the SamlInvalidateRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlLogout

public SamlLogoutResponse samlLogout(SamlLogoutRequest request)
                              throws IOException,
ElasticsearchException

Submits a request to invalidate an access token and refresh token.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlLogout

public final SamlLogoutResponse samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)
                                    throws IOException,
ElasticsearchException

Submits a request to invalidate an access token and refresh token.

Parameters:

fn - a function that initializes a builder to create the SamlLogoutRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public SamlPrepareAuthenticationResponse samlPrepareAuthentication(SamlPrepareAuthenticationRequest request)
                                                            throws IOException,
ElasticsearchException

Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public final SamlPrepareAuthenticationResponse samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)
                                                                  throws IOException,
ElasticsearchException

Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.

Parameters:

fn - a function that initializes a builder to create the SamlPrepareAuthenticationRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public SamlPrepareAuthenticationResponse samlPrepareAuthentication()
                                                            throws IOException,
ElasticsearchException

Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlServiceProviderMetadata

public SamlServiceProviderMetadataResponse samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request)
                                                                throws IOException,
ElasticsearchException

Generate SAML metadata for a SAML 2.0 Service Provider.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

samlServiceProviderMetadata

public final SamlServiceProviderMetadataResponse samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)
                                                                      throws IOException,
ElasticsearchException

Generate SAML metadata for a SAML 2.0 Service Provider.

Parameters:

fn - a function that initializes a builder to create the SamlServiceProviderMetadataRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

suggestUserProfiles

public SuggestUserProfilesResponse suggestUserProfiles(SuggestUserProfilesRequest request)
                                                throws IOException,
ElasticsearchException

Get suggestions for user profiles that match specified search criteria.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

suggestUserProfiles

public final SuggestUserProfilesResponse suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)
                                                      throws IOException,
ElasticsearchException

Get suggestions for user profiles that match specified search criteria.

Parameters:

fn - a function that initializes a builder to create the SuggestUserProfilesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

suggestUserProfiles

public SuggestUserProfilesResponse suggestUserProfiles()
                                                throws IOException,
ElasticsearchException

Get suggestions for user profiles that match specified search criteria.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateApiKey

public UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest request)
                                  throws IOException,
ElasticsearchException

Updates attributes of an existing API key. Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The access scope of an API key is derived from the role_descriptors you specify in the request, and a snapshot of the owner user’s permissions at the time of the request. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify role_descriptors in the request, a call to this API might still change the API key’s access scope. This change can occur if the owner user’s permissions have changed since the API key was created or last modified. To update another user’s API key, use the run_as feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateApiKey

public final UpdateApiKeyResponse updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)
                                        throws IOException,
ElasticsearchException

Updates attributes of an existing API key. Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The access scope of an API key is derived from the role_descriptors you specify in the request, and a snapshot of the owner user’s permissions at the time of the request. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify role_descriptors in the request, a call to this API might still change the API key’s access scope. This change can occur if the owner user’s permissions have changed since the API key was created or last modified. To update another user’s API key, use the run_as feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.

Parameters:

fn - a function that initializes a builder to create the UpdateApiKeyRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateUserProfileData

public UpdateUserProfileDataResponse updateUserProfileData(UpdateUserProfileDataRequest request)
                                                    throws IOException,
ElasticsearchException

Updates specific data for the user profile that's associated with the specified unique ID.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateUserProfileData

public final UpdateUserProfileDataResponse updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)
                                                          throws IOException,
ElasticsearchException

Updates specific data for the user profile that's associated with the specified unique ID.

Parameters:

fn - a function that initializes a builder to create the UpdateUserProfileDataRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co