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
`AuthenticateResponse`	`authenticate()`	Enables authentication as a user and retrieve information about the authenticated user.
`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.
`ChangePasswordResponse`	`changePassword(java.util.function.Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)`	Changes the passwords of users in the native realm and built-in users.
`ClearApiKeyCacheResponse`	`clearApiKeyCache(ClearApiKeyCacheRequest request)`	Clear a subset or all entries from the API key cache.
`ClearApiKeyCacheResponse`	`clearApiKeyCache(java.util.function.Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)`	Clear a subset or all entries from the API key cache.
`ClearCachedPrivilegesResponse`	`clearCachedPrivileges(ClearCachedPrivilegesRequest request)`	Evicts application privileges from the native application privileges cache.
`ClearCachedPrivilegesResponse`	`clearCachedPrivileges(java.util.function.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.
`ClearCachedRealmsResponse`	`clearCachedRealms(java.util.function.Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)`	Evicts users from the user cache.
`ClearCachedRolesResponse`	`clearCachedRoles(ClearCachedRolesRequest request)`	Evicts roles from the native role cache.
`ClearCachedRolesResponse`	`clearCachedRoles(java.util.function.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.
`ClearCachedServiceTokensResponse`	`clearCachedServiceTokens(java.util.function.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.
`CreateApiKeyResponse`	`createApiKey(java.util.function.Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)`	Creates an API key for access without requiring basic authentication.
`CreateServiceTokenResponse`	`createServiceToken(CreateServiceTokenRequest request)`	Creates a service account token for access without requiring basic authentication.
`CreateServiceTokenResponse`	`createServiceToken(java.util.function.Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)`	Creates a service account token for access without requiring basic authentication.
`DeletePrivilegesResponse`	`deletePrivileges(DeletePrivilegesRequest request)`	Removes application privileges.
`DeletePrivilegesResponse`	`deletePrivileges(java.util.function.Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)`	Removes application privileges.
`DeleteRoleResponse`	`deleteRole(DeleteRoleRequest request)`	Removes roles in the native realm.
`DeleteRoleResponse`	`deleteRole(java.util.function.Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)`	Removes roles in the native realm.
`DeleteRoleMappingResponse`	`deleteRoleMapping(DeleteRoleMappingRequest request)`	Removes role mappings.
`DeleteRoleMappingResponse`	`deleteRoleMapping(java.util.function.Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)`	Removes role mappings.
`DeleteServiceTokenResponse`	`deleteServiceToken(DeleteServiceTokenRequest request)`	Deletes a service account token.
`DeleteServiceTokenResponse`	`deleteServiceToken(java.util.function.Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)`	Deletes a service account token.
`DeleteUserResponse`	`deleteUser(DeleteUserRequest request)`	Deletes users from the native realm.
`DeleteUserResponse`	`deleteUser(java.util.function.Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)`	Deletes users from the native realm.
`DisableUserResponse`	`disableUser(DisableUserRequest request)`	Disables users in the native realm.
`DisableUserResponse`	`disableUser(java.util.function.Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)`	Disables users in the native realm.
`EnableUserResponse`	`enableUser(EnableUserRequest request)`	Enables users in the native realm.
`EnableUserResponse`	`enableUser(java.util.function.Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)`	Enables users in the native realm.
`GetApiKeyResponse`	`getApiKey()`	Retrieves information for one or more API keys.
`GetApiKeyResponse`	`getApiKey(GetApiKeyRequest request)`	Retrieves information for one or more API keys.
`GetApiKeyResponse`	`getApiKey(java.util.function.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.
`GetPrivilegesResponse`	`getPrivileges(java.util.function.Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)`	Retrieves application privileges.
`GetRoleResponse`	`getRole()`	Retrieves roles in the native realm.
`GetRoleResponse`	`getRole(GetRoleRequest request)`	Retrieves roles in the native realm.
`GetRoleResponse`	`getRole(java.util.function.Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)`	Retrieves roles in the native realm.
`GetRoleMappingResponse`	`getRoleMapping()`	Retrieves role mappings.
`GetRoleMappingResponse`	`getRoleMapping(GetRoleMappingRequest request)`	Retrieves role mappings.
`GetRoleMappingResponse`	`getRoleMapping(java.util.function.Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)`	Retrieves role mappings.
`GetServiceAccountsResponse`	`getServiceAccounts()`	Retrieves information about service accounts.
`GetServiceAccountsResponse`	`getServiceAccounts(GetServiceAccountsRequest request)`	Retrieves information about service accounts.
`GetServiceAccountsResponse`	`getServiceAccounts(java.util.function.Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)`	Retrieves information about service accounts.
`GetServiceCredentialsResponse`	`getServiceCredentials(GetServiceCredentialsRequest request)`	Retrieves information of all service credentials for a service account.
`GetServiceCredentialsResponse`	`getServiceCredentials(java.util.function.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.
`GetTokenResponse`	`getToken(java.util.function.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.
`GetUserResponse`	`getUser(java.util.function.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.
`GetUserPrivilegesResponse`	`getUserPrivileges(java.util.function.Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)`	Retrieves security privileges for the logged in user.
`GrantApiKeyResponse`	`grantApiKey(GrantApiKeyRequest request)`	Creates an API key on behalf of another user.
`GrantApiKeyResponse`	`grantApiKey(java.util.function.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.
`HasPrivilegesResponse`	`hasPrivileges(java.util.function.Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)`	Determines whether the specified user has a specified list of privileges.
`InvalidateApiKeyResponse`	`invalidateApiKey()`	Invalidates one or more API keys.
`InvalidateApiKeyResponse`	`invalidateApiKey(InvalidateApiKeyRequest request)`	Invalidates one or more API keys.
`InvalidateApiKeyResponse`	`invalidateApiKey(java.util.function.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.
`InvalidateTokenResponse`	`invalidateToken(java.util.function.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.
`PutPrivilegesResponse`	`putPrivileges(java.util.function.Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)`	Adds or updates application privileges.
`PutRoleResponse`	`putRole(PutRoleRequest request)`	Adds and updates roles in the native realm.
`PutRoleResponse`	`putRole(java.util.function.Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)`	Adds and updates roles in the native realm.
`PutRoleMappingResponse`	`putRoleMapping(PutRoleMappingRequest request)`	Creates and updates role mappings.
`PutRoleMappingResponse`	`putRoleMapping(java.util.function.Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)`	Creates and updates role mappings.
`PutUserResponse`	`putUser(PutUserRequest request)`	Adds and updates users in the native realm.
`PutUserResponse`	`putUser(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)`	Adds and updates users in the native realm.
`ElasticsearchSecurityClient`	`withTransportOptions(TransportOptions transportOptions)`	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_transport, _transportOptions, getDeserializer

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>
- authenticate
  
  public AuthenticateResponse authenticate() throws java.io.IOException, ElasticsearchException
  
  Enables authentication as a user and retrieve information about the authenticated user.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public ChangePasswordResponse changePassword(ChangePasswordRequest request) throws java.io.IOException, ElasticsearchException
  
  Changes the passwords of users in the native realm and built-in users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public final ChangePasswordResponse changePassword(java.util.function.Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public ChangePasswordResponse changePassword() throws java.io.IOException, ElasticsearchException
  
  Changes the passwords of users in the native realm and built-in users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearApiKeyCache
  
  public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request) throws java.io.IOException, ElasticsearchException
  
  Clear a subset or all entries from the API key cache.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearApiKeyCache
  
  public final ClearApiKeyCacheResponse clearApiKeyCache(java.util.function.Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Clear a subset or all entries from the API key cache.
  
  Parameters:
  
  fn - a function that initializes a builder to create the ClearApiKeyCacheRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedPrivileges
  
  public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Evicts application privileges from the native application privileges cache.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedPrivileges
  
  public final ClearCachedPrivilegesResponse clearCachedPrivileges(java.util.function.Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Evicts application privileges from the native application privileges cache.
  
  Parameters:
  
  fn - a function that initializes a builder to create the ClearCachedPrivilegesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRealms
  
  public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest request) throws java.io.IOException, ElasticsearchException
  
  Evicts users from the user cache. Can completely clear the cache or evict specific users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRealms
  
  public final ClearCachedRealmsResponse clearCachedRealms(java.util.function.Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRoles
  
  public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request) throws java.io.IOException, ElasticsearchException
  
  Evicts roles from the native role cache.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRoles
  
  public final ClearCachedRolesResponse clearCachedRoles(java.util.function.Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Evicts roles from the native role cache.
  
  Parameters:
  
  fn - a function that initializes a builder to create the ClearCachedRolesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedServiceTokens
  
  public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServiceTokensRequest request) throws java.io.IOException, ElasticsearchException
  
  Evicts tokens from the service account token caches.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedServiceTokens
  
  public final ClearCachedServiceTokensResponse clearCachedServiceTokens(java.util.function.Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Evicts tokens from the service account token caches.
  
  Parameters:
  
  fn - a function that initializes a builder to create the ClearCachedServiceTokensRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request) throws java.io.IOException, ElasticsearchException
  
  Creates an API key for access without requiring basic authentication.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public final CreateApiKeyResponse createApiKey(java.util.function.Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Creates an API key for access without requiring basic authentication.
  
  Parameters:
  
  fn - a function that initializes a builder to create the CreateApiKeyRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public CreateApiKeyResponse createApiKey() throws java.io.IOException, ElasticsearchException
  
  Creates an API key for access without requiring basic authentication.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createServiceToken
  
  public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest request) throws java.io.IOException, ElasticsearchException
  
  Creates a service account token for access without requiring basic authentication.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createServiceToken
  
  public final CreateServiceTokenResponse createServiceToken(java.util.function.Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Creates a service account token for access without requiring basic authentication.
  
  Parameters:
  
  fn - a function that initializes a builder to create the CreateServiceTokenRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deletePrivileges
  
  public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Removes application privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deletePrivileges
  
  public final DeletePrivilegesResponse deletePrivileges(java.util.function.Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Removes application privileges.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DeletePrivilegesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRole
  
  public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws java.io.IOException, ElasticsearchException
  
  Removes roles in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRole
  
  public final DeleteRoleResponse deleteRole(java.util.function.Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Removes roles in the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteRoleRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRoleMapping
  
  public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request) throws java.io.IOException, ElasticsearchException
  
  Removes role mappings.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRoleMapping
  
  public final DeleteRoleMappingResponse deleteRoleMapping(java.util.function.Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Removes role mappings.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteRoleMappingRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteServiceToken
  
  public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest request) throws java.io.IOException, ElasticsearchException
  
  Deletes a service account token.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteServiceToken
  
  public final DeleteServiceTokenResponse deleteServiceToken(java.util.function.Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Deletes a service account token.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteServiceTokenRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteUser
  
  public DeleteUserResponse deleteUser(DeleteUserRequest request) throws java.io.IOException, ElasticsearchException
  
  Deletes users from the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteUser
  
  public final DeleteUserResponse deleteUser(java.util.function.Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Deletes users from the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteUserRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUser
  
  public DisableUserResponse disableUser(DisableUserRequest request) throws java.io.IOException, ElasticsearchException
  
  Disables users in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUser
  
  public final DisableUserResponse disableUser(java.util.function.Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Disables users in the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the DisableUserRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUser
  
  public EnableUserResponse enableUser(EnableUserRequest request) throws java.io.IOException, ElasticsearchException
  
  Enables users in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUser
  
  public final EnableUserResponse enableUser(java.util.function.Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Enables users in the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the EnableUserRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public GetApiKeyResponse getApiKey(GetApiKeyRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves information for one or more API keys.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public final GetApiKeyResponse getApiKey(java.util.function.Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves information for one or more API keys.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetApiKeyRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public GetApiKeyResponse getApiKey() throws java.io.IOException, ElasticsearchException
  
  Retrieves information for one or more API keys.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getBuiltinPrivileges
  
  public GetBuiltinPrivilegesResponse getBuiltinPrivileges() throws java.io.IOException, ElasticsearchException
  
  Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves application privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public final GetPrivilegesResponse getPrivileges(java.util.function.Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves application privileges.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetPrivilegesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public GetPrivilegesResponse getPrivileges() throws java.io.IOException, ElasticsearchException
  
  Retrieves application privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public GetRoleResponse getRole(GetRoleRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves roles in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public final GetRoleResponse getRole(java.util.function.Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves roles in the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetRoleRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public GetRoleResponse getRole() throws java.io.IOException, ElasticsearchException
  
  Retrieves roles in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves role mappings.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public final GetRoleMappingResponse getRoleMapping(java.util.function.Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves role mappings.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetRoleMappingRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public GetRoleMappingResponse getRoleMapping() throws java.io.IOException, ElasticsearchException
  
  Retrieves role mappings.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves information about service accounts.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public final GetServiceAccountsResponse getServiceAccounts(java.util.function.Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves information about service accounts.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetServiceAccountsRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public GetServiceAccountsResponse getServiceAccounts() throws java.io.IOException, ElasticsearchException
  
  Retrieves information about service accounts.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceCredentials
  
  public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentialsRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves information of all service credentials for a service account.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceCredentials
  
  public final GetServiceCredentialsResponse getServiceCredentials(java.util.function.Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public GetTokenResponse getToken(GetTokenRequest request) throws java.io.IOException, ElasticsearchException
  
  Creates a bearer token for access without requiring basic authentication.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public final GetTokenResponse getToken(java.util.function.Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public GetTokenResponse getToken() throws java.io.IOException, ElasticsearchException
  
  Creates a bearer token for access without requiring basic authentication.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public GetUserResponse getUser(GetUserRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves information about users in the native realm and built-in users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public final GetUserResponse getUser(java.util.function.Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public GetUserResponse getUser() throws java.io.IOException, ElasticsearchException
  
  Retrieves information about users in the native realm and built-in users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Retrieves security privileges for the logged in user.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public final GetUserPrivilegesResponse getUserPrivileges(java.util.function.Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Retrieves security privileges for the logged in user.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GetUserPrivilegesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public GetUserPrivilegesResponse getUserPrivileges() throws java.io.IOException, ElasticsearchException
  
  Retrieves security privileges for the logged in user.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- grantApiKey
  
  public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request) throws java.io.IOException, ElasticsearchException
  
  Creates an API key on behalf of another user.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- grantApiKey
  
  public final GrantApiKeyResponse grantApiKey(java.util.function.Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Creates an API key on behalf of another user.
  
  Parameters:
  
  fn - a function that initializes a builder to create the GrantApiKeyRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Determines whether the specified user has a specified list of privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public final HasPrivilegesResponse hasPrivileges(java.util.function.Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public HasPrivilegesResponse hasPrivileges() throws java.io.IOException, ElasticsearchException
  
  Determines whether the specified user has a specified list of privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request) throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more API keys.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public final InvalidateApiKeyResponse invalidateApiKey(java.util.function.Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more API keys.
  
  Parameters:
  
  fn - a function that initializes a builder to create the InvalidateApiKeyRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public InvalidateApiKeyResponse invalidateApiKey() throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more API keys.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request) throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more access tokens or refresh tokens.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public final InvalidateTokenResponse invalidateToken(java.util.function.Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more access tokens or refresh tokens.
  
  Parameters:
  
  fn - a function that initializes a builder to create the InvalidateTokenRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public InvalidateTokenResponse invalidateToken() throws java.io.IOException, ElasticsearchException
  
  Invalidates one or more access tokens or refresh tokens.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request) throws java.io.IOException, ElasticsearchException
  
  Adds or updates application privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public final PutPrivilegesResponse putPrivileges(java.util.function.Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Adds or updates application privileges.
  
  Parameters:
  
  fn - a function that initializes a builder to create the PutPrivilegesRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public PutPrivilegesResponse putPrivileges() throws java.io.IOException, ElasticsearchException
  
  Adds or updates application privileges.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRole
  
  public PutRoleResponse putRole(PutRoleRequest request) throws java.io.IOException, ElasticsearchException
  
  Adds and updates roles in the native realm.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRole
  
  public final PutRoleResponse putRole(java.util.function.Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Adds and updates roles in the native realm.
  
  Parameters:
  
  fn - a function that initializes a builder to create the PutRoleRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRoleMapping
  
  public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request) throws java.io.IOException, ElasticsearchException
  
  Creates and updates role mappings.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRoleMapping
  
  public final PutRoleMappingResponse putRoleMapping(java.util.function.Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn) throws java.io.IOException, ElasticsearchException
  
  Creates and updates role mappings.
  
  Parameters:
  
  fn - a function that initializes a builder to create the PutRoleMappingRequest
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putUser
  
  public PutUserResponse putUser(PutUserRequest request) throws java.io.IOException, ElasticsearchException
  
  Adds and updates users in the native realm. These users are commonly referred to as native users.
  
  Throws:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putUser
  
  public final PutUserResponse putUser(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn) throws java.io.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:
  
  java.io.IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co

Class ElasticsearchSecurityClient

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

Constructor Summary

Method Summary

Methods inherited from class co.elastic.clients.ApiClient

Methods inherited from class java.lang.Object

Constructor Details

ElasticsearchSecurityClient

ElasticsearchSecurityClient

Method Details

withTransportOptions

authenticate

changePassword

changePassword

changePassword

clearApiKeyCache

clearApiKeyCache

clearCachedPrivileges

clearCachedPrivileges

clearCachedRealms

clearCachedRealms

clearCachedRoles

clearCachedRoles

clearCachedServiceTokens

clearCachedServiceTokens

createApiKey

createApiKey

createApiKey

createServiceToken

createServiceToken

deletePrivileges

deletePrivileges

deleteRole

deleteRole

deleteRoleMapping

deleteRoleMapping

deleteServiceToken

deleteServiceToken

deleteUser

deleteUser

disableUser

disableUser

enableUser

enableUser

getApiKey

getApiKey

getApiKey

getBuiltinPrivileges

getPrivileges

getPrivileges

getPrivileges

getRole

getRole

getRole

getRoleMapping

getRoleMapping

getRoleMapping

getServiceAccounts

getServiceAccounts

getServiceAccounts

getServiceCredentials

getServiceCredentials

getToken

getToken

getToken

getUser

getUser

getUser

getUserPrivileges

getUserPrivileges

getUserPrivileges

grantApiKey

grantApiKey

hasPrivileges

hasPrivileges

hasPrivileges

invalidateApiKey

invalidateApiKey

invalidateApiKey