Class ElasticsearchSecurityAsyncClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>
co.elastic.clients.elasticsearch.security.ElasticsearchSecurityAsyncClient
public class ElasticsearchSecurityAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>
Client for the security namespace.
-
Field Summary
Fields inherited from class co.elastic.clients.ApiClient
transport, transportOptions
-
Constructor Summary
ConstructorDescriptionElasticsearchSecurityAsyncClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionEnables authentication as a user and retrieve information about the authenticated user.Changes the passwords of users in the native realm and built-in users.changePassword
(ChangePasswordRequest request) Changes the passwords of users in the native realm and built-in users.Changes the passwords of users in the native realm and built-in users.clearApiKeyCache
(ClearApiKeyCacheRequest request) Clear a subset or all entries from the API key cache.clearApiKeyCache
(Function<ClearApiKeyCacheRequest.Builder, ObjectBuilder<ClearApiKeyCacheRequest>> fn) Clear a subset or all entries from the API key cache.Evicts application privileges from the native application privileges cache.clearCachedPrivileges
(Function<ClearCachedPrivilegesRequest.Builder, ObjectBuilder<ClearCachedPrivilegesRequest>> fn) Evicts application privileges from the native application privileges cache.Evicts users from the user cache.clearCachedRealms
(Function<ClearCachedRealmsRequest.Builder, ObjectBuilder<ClearCachedRealmsRequest>> fn) Evicts users from the user cache.clearCachedRoles
(ClearCachedRolesRequest request) Evicts roles from the native role cache.clearCachedRoles
(Function<ClearCachedRolesRequest.Builder, ObjectBuilder<ClearCachedRolesRequest>> fn) Evicts roles from the native role cache.Evicts tokens from the service account token caches.clearCachedServiceTokens
(Function<ClearCachedServiceTokensRequest.Builder, ObjectBuilder<ClearCachedServiceTokensRequest>> fn) Evicts tokens from the service account token caches.Creates an API key for access without requiring basic authentication.createApiKey
(CreateApiKeyRequest request) Creates an API key for access without requiring basic authentication.Creates an API key for access without requiring basic authentication.Creates a service account token for access without requiring basic authentication.createServiceToken
(Function<CreateServiceTokenRequest.Builder, ObjectBuilder<CreateServiceTokenRequest>> fn) Creates a service account token for access without requiring basic authentication.deletePrivileges
(DeletePrivilegesRequest request) Removes application privileges.deletePrivileges
(Function<DeletePrivilegesRequest.Builder, ObjectBuilder<DeletePrivilegesRequest>> fn) Removes application privileges.deleteRole
(DeleteRoleRequest request) Removes roles in the native realm.Removes roles in the native realm.Removes role mappings.deleteRoleMapping
(Function<DeleteRoleMappingRequest.Builder, ObjectBuilder<DeleteRoleMappingRequest>> fn) Removes role mappings.Deletes a service account token.deleteServiceToken
(Function<DeleteServiceTokenRequest.Builder, ObjectBuilder<DeleteServiceTokenRequest>> fn) Deletes a service account token.deleteUser
(DeleteUserRequest request) Deletes users from the native realm.Deletes users from the native realm.disableUser
(DisableUserRequest request) Disables users in the native realm.Disables users in the native realm.enableUser
(EnableUserRequest request) Enables users in the native realm.Enables users in the native realm.Retrieves information for one or more API keys.getApiKey
(GetApiKeyRequest request) Retrieves information for one or more API keys.Retrieves information for one or more API keys.Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.Retrieves application privileges.getPrivileges
(GetPrivilegesRequest request) Retrieves application privileges.Retrieves application privileges.getRole()
Retrieves roles in the native realm.getRole
(GetRoleRequest request) Retrieves roles in the native realm.final CompletableFuture<GetRoleResponse>
Retrieves roles in the native realm.Retrieves role mappings.getRoleMapping
(GetRoleMappingRequest request) Retrieves role mappings.Retrieves role mappings.Retrieves information about service accounts.Retrieves information about service accounts.getServiceAccounts
(Function<GetServiceAccountsRequest.Builder, ObjectBuilder<GetServiceAccountsRequest>> fn) Retrieves information about service accounts.Retrieves information of all service credentials for a service account.getServiceCredentials
(Function<GetServiceCredentialsRequest.Builder, ObjectBuilder<GetServiceCredentialsRequest>> fn) Retrieves information of all service credentials for a service account.getToken()
Creates a bearer token for access without requiring basic authentication.getToken
(GetTokenRequest request) Creates a bearer token for access without requiring basic authentication.Creates a bearer token for access without requiring basic authentication.getUser()
Retrieves information about users in the native realm and built-in users.getUser
(GetUserRequest request) Retrieves information about users in the native realm and built-in users.final CompletableFuture<GetUserResponse>
Retrieves information about users in the native realm and built-in users.Retrieves security privileges for the logged in user.Retrieves security privileges for the logged in user.getUserPrivileges
(Function<GetUserPrivilegesRequest.Builder, ObjectBuilder<GetUserPrivilegesRequest>> fn) Retrieves security privileges for the logged in user.grantApiKey
(GrantApiKeyRequest request) Creates an API key on behalf of another user.Creates an API key on behalf of another user.Determines whether the specified user has a specified list of privileges.hasPrivileges
(HasPrivilegesRequest request) Determines whether the specified user has a specified list of privileges.Determines whether the specified user has a specified list of privileges.Invalidates one or more API keys.invalidateApiKey
(InvalidateApiKeyRequest request) Invalidates one or more API keys.invalidateApiKey
(Function<InvalidateApiKeyRequest.Builder, ObjectBuilder<InvalidateApiKeyRequest>> fn) Invalidates one or more API keys.Invalidates one or more access tokens or refresh tokens.invalidateToken
(InvalidateTokenRequest request) Invalidates one or more access tokens or refresh tokens.Invalidates one or more access tokens or refresh tokens.Adds or updates application privileges.putPrivileges
(PutPrivilegesRequest request) Adds or updates application privileges.Adds or updates application privileges.putRole
(PutRoleRequest request) Adds and updates roles in the native realm.final CompletableFuture<PutRoleResponse>
Adds and updates roles in the native realm.putRoleMapping
(PutRoleMappingRequest request) Creates and updates role mappings.Creates and updates role mappings.putUser
(PutUserRequest request) Adds and updates users in the native realm.final CompletableFuture<PutUserResponse>
Adds and updates users in the native realm.withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchSecurityAsyncClient
-
ElasticsearchSecurityAsyncClient
public ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
public ElasticsearchSecurityAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions) Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchSecurityAsyncClient>
-
authenticate
Enables authentication as a user and retrieve information about the authenticated user.- See Also:
-
changePassword
Changes the passwords of users in the native realm and built-in users.- See Also:
-
changePassword
public final CompletableFuture<ChangePasswordResponse> changePassword(Function<ChangePasswordRequest.Builder, ObjectBuilder<ChangePasswordRequest>> fn) Changes the passwords of users in the native realm and built-in users.- Parameters:
fn
- a function that initializes a builder to create theChangePasswordRequest
- See Also:
-
changePassword
Changes the passwords of users in the native realm and built-in users.- See Also:
-
clearApiKeyCache
public CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(ClearApiKeyCacheRequest request) Clear a subset or all entries from the API key cache.- See Also:
-
clearApiKeyCache
public final CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder, ObjectBuilder<ClearApiKeyCacheRequest>> fn) Clear a subset or all entries from the API key cache.- Parameters:
fn
- a function that initializes a builder to create theClearApiKeyCacheRequest
- See Also:
-
clearCachedPrivileges
public CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(ClearCachedPrivilegesRequest request) Evicts application privileges from the native application privileges cache.- See Also:
-
clearCachedPrivileges
public final CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder, ObjectBuilder<ClearCachedPrivilegesRequest>> fn) Evicts application privileges from the native application privileges cache.- Parameters:
fn
- a function that initializes a builder to create theClearCachedPrivilegesRequest
- See Also:
-
clearCachedRealms
public CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(ClearCachedRealmsRequest request) Evicts users from the user cache. Can completely clear the cache or evict specific users.- See Also:
-
clearCachedRealms
public final CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(Function<ClearCachedRealmsRequest.Builder, ObjectBuilder<ClearCachedRealmsRequest>> fn) 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 theClearCachedRealmsRequest
- See Also:
-
clearCachedRoles
public CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(ClearCachedRolesRequest request) Evicts roles from the native role cache.- See Also:
-
clearCachedRoles
public final CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(Function<ClearCachedRolesRequest.Builder, ObjectBuilder<ClearCachedRolesRequest>> fn) Evicts roles from the native role cache.- Parameters:
fn
- a function that initializes a builder to create theClearCachedRolesRequest
- See Also:
-
clearCachedServiceTokens
public CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(ClearCachedServiceTokensRequest request) Evicts tokens from the service account token caches.- See Also:
-
clearCachedServiceTokens
public final CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder, ObjectBuilder<ClearCachedServiceTokensRequest>> fn) Evicts tokens from the service account token caches.- Parameters:
fn
- a function that initializes a builder to create theClearCachedServiceTokensRequest
- See Also:
-
createApiKey
Creates an API key for access without requiring basic authentication.- See Also:
-
createApiKey
public final CompletableFuture<CreateApiKeyResponse> createApiKey(Function<CreateApiKeyRequest.Builder, ObjectBuilder<CreateApiKeyRequest>> fn) Creates an API key for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theCreateApiKeyRequest
- See Also:
-
createApiKey
Creates an API key for access without requiring basic authentication.- See Also:
-
createServiceToken
public CompletableFuture<CreateServiceTokenResponse> createServiceToken(CreateServiceTokenRequest request) Creates a service account token for access without requiring basic authentication.- See Also:
-
createServiceToken
public final CompletableFuture<CreateServiceTokenResponse> createServiceToken(Function<CreateServiceTokenRequest.Builder, ObjectBuilder<CreateServiceTokenRequest>> fn) Creates a service account token for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theCreateServiceTokenRequest
- See Also:
-
deletePrivileges
public CompletableFuture<DeletePrivilegesResponse> deletePrivileges(DeletePrivilegesRequest request) Removes application privileges.- See Also:
-
deletePrivileges
public final CompletableFuture<DeletePrivilegesResponse> deletePrivileges(Function<DeletePrivilegesRequest.Builder, ObjectBuilder<DeletePrivilegesRequest>> fn) Removes application privileges.- Parameters:
fn
- a function that initializes a builder to create theDeletePrivilegesRequest
- See Also:
-
deleteRole
Removes roles in the native realm.- See Also:
-
deleteRole
public final CompletableFuture<DeleteRoleResponse> deleteRole(Function<DeleteRoleRequest.Builder, ObjectBuilder<DeleteRoleRequest>> fn) Removes roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create theDeleteRoleRequest
- See Also:
-
deleteRoleMapping
public CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(DeleteRoleMappingRequest request) Removes role mappings.- See Also:
-
deleteRoleMapping
public final CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder, ObjectBuilder<DeleteRoleMappingRequest>> fn) Removes role mappings.- Parameters:
fn
- a function that initializes a builder to create theDeleteRoleMappingRequest
- See Also:
-
deleteServiceToken
public CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(DeleteServiceTokenRequest request) Deletes a service account token.- See Also:
-
deleteServiceToken
public final CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(Function<DeleteServiceTokenRequest.Builder, ObjectBuilder<DeleteServiceTokenRequest>> fn) Deletes a service account token.- Parameters:
fn
- a function that initializes a builder to create theDeleteServiceTokenRequest
- See Also:
-
deleteUser
Deletes users from the native realm.- See Also:
-
deleteUser
public final CompletableFuture<DeleteUserResponse> deleteUser(Function<DeleteUserRequest.Builder, ObjectBuilder<DeleteUserRequest>> fn) Deletes users from the native realm.- Parameters:
fn
- a function that initializes a builder to create theDeleteUserRequest
- See Also:
-
disableUser
Disables users in the native realm.- See Also:
-
disableUser
public final CompletableFuture<DisableUserResponse> disableUser(Function<DisableUserRequest.Builder, ObjectBuilder<DisableUserRequest>> fn) Disables users in the native realm.- Parameters:
fn
- a function that initializes a builder to create theDisableUserRequest
- See Also:
-
enableUser
Enables users in the native realm.- See Also:
-
enableUser
public final CompletableFuture<EnableUserResponse> enableUser(Function<EnableUserRequest.Builder, ObjectBuilder<EnableUserRequest>> fn) Enables users in the native realm.- Parameters:
fn
- a function that initializes a builder to create theEnableUserRequest
- See Also:
-
getApiKey
Retrieves information for one or more API keys.- See Also:
-
getApiKey
public final CompletableFuture<GetApiKeyResponse> getApiKey(Function<GetApiKeyRequest.Builder, ObjectBuilder<GetApiKeyRequest>> fn) Retrieves information for one or more API keys.- Parameters:
fn
- a function that initializes a builder to create theGetApiKeyRequest
- See Also:
-
getApiKey
Retrieves information for one or more API keys.- See Also:
-
getBuiltinPrivileges
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.- See Also:
-
getPrivileges
Retrieves application privileges.- See Also:
-
getPrivileges
public final CompletableFuture<GetPrivilegesResponse> getPrivileges(Function<GetPrivilegesRequest.Builder, ObjectBuilder<GetPrivilegesRequest>> fn) Retrieves application privileges.- Parameters:
fn
- a function that initializes a builder to create theGetPrivilegesRequest
- See Also:
-
getPrivileges
Retrieves application privileges.- See Also:
-
getRole
Retrieves roles in the native realm.- See Also:
-
getRole
public final CompletableFuture<GetRoleResponse> getRole(Function<GetRoleRequest.Builder, ObjectBuilder<GetRoleRequest>> fn) Retrieves roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create theGetRoleRequest
- See Also:
-
getRole
Retrieves roles in the native realm.- See Also:
-
getRoleMapping
Retrieves role mappings.- See Also:
-
getRoleMapping
public final CompletableFuture<GetRoleMappingResponse> getRoleMapping(Function<GetRoleMappingRequest.Builder, ObjectBuilder<GetRoleMappingRequest>> fn) Retrieves role mappings.- Parameters:
fn
- a function that initializes a builder to create theGetRoleMappingRequest
- See Also:
-
getRoleMapping
Retrieves role mappings.- See Also:
-
getServiceAccounts
public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(GetServiceAccountsRequest request) Retrieves information about service accounts.- See Also:
-
getServiceAccounts
public final CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(Function<GetServiceAccountsRequest.Builder, ObjectBuilder<GetServiceAccountsRequest>> fn) Retrieves information about service accounts.- Parameters:
fn
- a function that initializes a builder to create theGetServiceAccountsRequest
- See Also:
-
getServiceAccounts
Retrieves information about service accounts.- See Also:
-
getServiceCredentials
public CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(GetServiceCredentialsRequest request) Retrieves information of all service credentials for a service account.- See Also:
-
getServiceCredentials
public final CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(Function<GetServiceCredentialsRequest.Builder, ObjectBuilder<GetServiceCredentialsRequest>> fn) Retrieves information of all service credentials for a service account.- Parameters:
fn
- a function that initializes a builder to create theGetServiceCredentialsRequest
- See Also:
-
getToken
Creates a bearer token for access without requiring basic authentication.- See Also:
-
getToken
public final CompletableFuture<GetTokenResponse> getToken(Function<GetTokenRequest.Builder, ObjectBuilder<GetTokenRequest>> fn) Creates a bearer token for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theGetTokenRequest
- See Also:
-
getToken
Creates a bearer token for access without requiring basic authentication.- See Also:
-
getUser
Retrieves information about users in the native realm and built-in users.- See Also:
-
getUser
public final CompletableFuture<GetUserResponse> getUser(Function<GetUserRequest.Builder, ObjectBuilder<GetUserRequest>> fn) Retrieves information about users in the native realm and built-in users.- Parameters:
fn
- a function that initializes a builder to create theGetUserRequest
- See Also:
-
getUser
Retrieves information about users in the native realm and built-in users.- See Also:
-
getUserPrivileges
public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(GetUserPrivilegesRequest request) Retrieves security privileges for the logged in user.- See Also:
-
getUserPrivileges
public final CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(Function<GetUserPrivilegesRequest.Builder, ObjectBuilder<GetUserPrivilegesRequest>> fn) Retrieves security privileges for the logged in user.- Parameters:
fn
- a function that initializes a builder to create theGetUserPrivilegesRequest
- See Also:
-
getUserPrivileges
Retrieves security privileges for the logged in user.- See Also:
-
grantApiKey
Creates an API key on behalf of another user.- See Also:
-
grantApiKey
public final CompletableFuture<GrantApiKeyResponse> grantApiKey(Function<GrantApiKeyRequest.Builder, ObjectBuilder<GrantApiKeyRequest>> fn) Creates an API key on behalf of another user.- Parameters:
fn
- a function that initializes a builder to create theGrantApiKeyRequest
- See Also:
-
hasPrivileges
Determines whether the specified user has a specified list of privileges.- See Also:
-
hasPrivileges
public final CompletableFuture<HasPrivilegesResponse> hasPrivileges(Function<HasPrivilegesRequest.Builder, ObjectBuilder<HasPrivilegesRequest>> fn) Determines whether the specified user has a specified list of privileges.- Parameters:
fn
- a function that initializes a builder to create theHasPrivilegesRequest
- See Also:
-
hasPrivileges
Determines whether the specified user has a specified list of privileges.- See Also:
-
invalidateApiKey
public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(InvalidateApiKeyRequest request) Invalidates one or more API keys.- See Also:
-
invalidateApiKey
public final CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(Function<InvalidateApiKeyRequest.Builder, ObjectBuilder<InvalidateApiKeyRequest>> fn) Invalidates one or more API keys.- Parameters:
fn
- a function that initializes a builder to create theInvalidateApiKeyRequest
- See Also:
-
invalidateApiKey
Invalidates one or more API keys.- See Also:
-
invalidateToken
Invalidates one or more access tokens or refresh tokens.- See Also:
-
invalidateToken
public final CompletableFuture<InvalidateTokenResponse> invalidateToken(Function<InvalidateTokenRequest.Builder, ObjectBuilder<InvalidateTokenRequest>> fn) Invalidates one or more access tokens or refresh tokens.- Parameters:
fn
- a function that initializes a builder to create theInvalidateTokenRequest
- See Also:
-
invalidateToken
Invalidates one or more access tokens or refresh tokens.- See Also:
-
putPrivileges
Adds or updates application privileges.- See Also:
-
putPrivileges
public final CompletableFuture<PutPrivilegesResponse> putPrivileges(Function<PutPrivilegesRequest.Builder, ObjectBuilder<PutPrivilegesRequest>> fn) Adds or updates application privileges.- Parameters:
fn
- a function that initializes a builder to create thePutPrivilegesRequest
- See Also:
-
putPrivileges
Adds or updates application privileges.- See Also:
-
putRole
Adds and updates roles in the native realm.- See Also:
-
putRole
public final CompletableFuture<PutRoleResponse> putRole(Function<PutRoleRequest.Builder, ObjectBuilder<PutRoleRequest>> fn) Adds and updates roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create thePutRoleRequest
- See Also:
-
putRoleMapping
Creates and updates role mappings.- See Also:
-
putRoleMapping
public final CompletableFuture<PutRoleMappingResponse> putRoleMapping(Function<PutRoleMappingRequest.Builder, ObjectBuilder<PutRoleMappingRequest>> fn) Creates and updates role mappings.- Parameters:
fn
- a function that initializes a builder to create thePutRoleMappingRequest
- See Also:
-
putUser
Adds and updates users in the native realm. These users are commonly referred to as native users.- See Also:
-
putUser
public final CompletableFuture<PutUserResponse> putUser(Function<PutUserRequest.Builder, ObjectBuilder<PutUserRequest>> fn) 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 thePutUserRequest
- See Also:
-