Package co.elastic.clients.elasticsearch.security

Class ElasticsearchSecurityAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.security.ElasticsearchSecurityAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

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

Constructors

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

Method Summary

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

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSecurityAsyncClient

public ElasticsearchSecurityAsyncClient(ElasticsearchTransport transport)

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 class ApiClient<ElasticsearchTransport,ElasticsearchSecurityAsyncClient>

activateUserProfile

public CompletableFuture<ActivateUserProfileResponse> activateUserProfile(ActivateUserProfileRequest request)

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

See Also:

• Documentation on elastic.co

activateUserProfile

public final CompletableFuture<ActivateUserProfileResponse> activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

authenticate

public CompletableFuture<AuthenticateResponse> authenticate()

Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a basic auth header. 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.

See Also:

• Documentation on elastic.co

bulkDeleteRole

public CompletableFuture<BulkDeleteRoleResponse> bulkDeleteRole(BulkDeleteRoleRequest request)

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.

See Also:

• Documentation on elastic.co

bulkDeleteRole

public final CompletableFuture<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. 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

See Also:

• Documentation on elastic.co

bulkPutRole

public CompletableFuture<BulkPutRoleResponse> bulkPutRole(BulkPutRoleRequest request)

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.

See Also:

• Documentation on elastic.co

bulkPutRole

public final CompletableFuture<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. 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

See Also:

• Documentation on elastic.co

changePassword

public CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRequest request)

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

See Also:

• Documentation on elastic.co

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 the ChangePasswordRequest

See Also:

• Documentation on elastic.co

changePassword

public CompletableFuture<ChangePasswordResponse> changePassword()

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

See Also:

• Documentation on elastic.co

clearApiKeyCache

public CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(ClearApiKeyCacheRequest request)

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

See Also:

• Documentation on elastic.co

clearApiKeyCache

public final CompletableFuture<ClearApiKeyCacheResponse> clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)

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

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(ClearCachedPrivilegesRequest request)

Evicts application privileges from the native application privileges cache.

See Also:

• Documentation on elastic.co

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 the ClearCachedPrivilegesRequest

See Also:

• Documentation on elastic.co

clearCachedRealms

public CompletableFuture<ClearCachedRealmsResponse> clearCachedRealms(ClearCachedRealmsRequest request)

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

See Also:

• Documentation on elastic.co

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 the ClearCachedRealmsRequest

See Also:

• Documentation on elastic.co

clearCachedRoles

public CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(ClearCachedRolesRequest request)

Evicts roles from the native role cache.

See Also:

• Documentation on elastic.co

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 the ClearCachedRolesRequest

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(ClearCachedServiceTokensRequest request)

Evicts tokens from the service account token caches.

See Also:

• Documentation on elastic.co

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 the ClearCachedServiceTokensRequest

See Also:

• Documentation on elastic.co

createApiKey

public CompletableFuture<CreateApiKeyResponse> createApiKey(CreateApiKeyRequest request)

Create an API key. 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.

See Also:

• Documentation on elastic.co

createApiKey

public final CompletableFuture<CreateApiKeyResponse> createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)

Create an API key. 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

See Also:

• Documentation on elastic.co

createApiKey

public CompletableFuture<CreateApiKeyResponse> createApiKey()

Create an API key. 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.

See Also:

• Documentation on elastic.co

createServiceToken

public CompletableFuture<CreateServiceTokenResponse> createServiceToken(CreateServiceTokenRequest request)

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

See Also:

• Documentation on elastic.co

createServiceToken

public final CompletableFuture<CreateServiceTokenResponse> createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

deletePrivileges

public CompletableFuture<DeletePrivilegesResponse> deletePrivileges(DeletePrivilegesRequest request)

Removes application privileges.

See Also:

• Documentation on elastic.co

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 the DeletePrivilegesRequest

See Also:

• Documentation on elastic.co

deleteRole

public CompletableFuture<DeleteRoleResponse> deleteRole(DeleteRoleRequest request)

Removes roles in the native realm.

See Also:

• Documentation on elastic.co

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 the DeleteRoleRequest

See Also:

• Documentation on elastic.co

deleteRoleMapping

public CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(DeleteRoleMappingRequest request)

Removes role mappings.

See Also:

• Documentation on elastic.co

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 the DeleteRoleMappingRequest

See Also:

• Documentation on elastic.co

deleteServiceToken

public CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(DeleteServiceTokenRequest request)

Deletes a service account token.

See Also:

• Documentation on elastic.co

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 the DeleteServiceTokenRequest

See Also:

• Documentation on elastic.co

deleteUser

public CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest request)

Deletes users from the native realm.

See Also:

• Documentation on elastic.co

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 the DeleteUserRequest

See Also:

• Documentation on elastic.co

disableUser

public CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest request)

Disables users in the native realm.

See Also:

• Documentation on elastic.co

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 the DisableUserRequest

See Also:

• Documentation on elastic.co

disableUserProfile

public CompletableFuture<DisableUserProfileResponse> disableUserProfile(DisableUserProfileRequest request)

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

See Also:

• Documentation on elastic.co

disableUserProfile

public final CompletableFuture<DisableUserProfileResponse> disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)

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

See Also:

• Documentation on elastic.co

enableUser

public CompletableFuture<EnableUserResponse> enableUser(EnableUserRequest request)

Enables users in the native realm.

See Also:

• Documentation on elastic.co

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 the EnableUserRequest

See Also:

• Documentation on elastic.co

enableUserProfile

public CompletableFuture<EnableUserProfileResponse> enableUserProfile(EnableUserProfileRequest request)

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

See Also:

• Documentation on elastic.co

enableUserProfile

public final CompletableFuture<EnableUserProfileResponse> enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

enrollKibana

public CompletableFuture<EnrollKibanaResponse> enrollKibana()

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

See Also:

• Documentation on elastic.co

enrollNode

public CompletableFuture<EnrollNodeResponse> enrollNode()

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

See Also:

• Documentation on elastic.co

getApiKey

public CompletableFuture<GetApiKeyResponse> getApiKey(GetApiKeyRequest request)

Get API key information. 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.

See Also:

• Documentation on elastic.co

getApiKey

public final CompletableFuture<GetApiKeyResponse> getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)

Get API key information. 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

See Also:

• Documentation on elastic.co

getApiKey

public CompletableFuture<GetApiKeyResponse> getApiKey()

Get API key information. 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.

See Also:

• Documentation on elastic.co

getBuiltinPrivileges

public CompletableFuture<GetBuiltinPrivilegesResponse> getBuiltinPrivileges()

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

See Also:

• Documentation on elastic.co

getPrivileges

public CompletableFuture<GetPrivilegesResponse> getPrivileges(GetPrivilegesRequest request)

Retrieves application privileges.

See Also:

• Documentation on elastic.co

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 the GetPrivilegesRequest

See Also:

• Documentation on elastic.co

getPrivileges

public CompletableFuture<GetPrivilegesResponse> getPrivileges()

Retrieves application privileges.

See Also:

• Documentation on elastic.co

getRole

public CompletableFuture<GetRoleResponse> getRole(GetRoleRequest request)

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.

See Also:

• Documentation on elastic.co

getRole

public final CompletableFuture<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. 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

See Also:

• Documentation on elastic.co

getRole

public CompletableFuture<GetRoleResponse> getRole()

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.

See Also:

• Documentation on elastic.co

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping(GetRoleMappingRequest request)

Retrieves role mappings.

See Also:

• Documentation on elastic.co

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 the GetRoleMappingRequest

See Also:

• Documentation on elastic.co

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping()

Retrieves role mappings.

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(GetServiceAccountsRequest request)

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

See Also:

• Documentation on elastic.co

getServiceAccounts

public final CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)

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

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts()

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

See Also:

• Documentation on elastic.co

getServiceCredentials

public CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(GetServiceCredentialsRequest request)

Retrieves information of all service credentials for a service account.

See Also:

• Documentation on elastic.co

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 the GetServiceCredentialsRequest

See Also:

• Documentation on elastic.co

getToken

public CompletableFuture<GetTokenResponse> getToken(GetTokenRequest request)

Creates a bearer token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

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 the GetTokenRequest

See Also:

• Documentation on elastic.co

getToken

public CompletableFuture<GetTokenResponse> getToken()

Creates a bearer token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

getUser

public CompletableFuture<GetUserResponse> getUser(GetUserRequest request)

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

See Also:

• Documentation on elastic.co

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 the GetUserRequest

See Also:

• Documentation on elastic.co

getUser

public CompletableFuture<GetUserResponse> getUser()

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

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(GetUserPrivilegesRequest request)

Retrieves security privileges for the logged in user.

See Also:

• Documentation on elastic.co

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 the GetUserPrivilegesRequest

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges()

Retrieves security privileges for the logged in user.

See Also:

• Documentation on elastic.co

getUserProfile

public CompletableFuture<GetUserProfileResponse> getUserProfile(GetUserProfileRequest request)

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

See Also:

• Documentation on elastic.co

getUserProfile

public final CompletableFuture<GetUserProfileResponse> getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

grantApiKey

public CompletableFuture<GrantApiKeyResponse> grantApiKey(GrantApiKeyRequest request)

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.

See Also:

• Documentation on elastic.co

grantApiKey

public final CompletableFuture<GrantApiKeyResponse> grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)

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

See Also:

• Documentation on elastic.co

hasPrivileges

public CompletableFuture<HasPrivilegesResponse> hasPrivileges(HasPrivilegesRequest request)

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

See Also:

• Documentation on elastic.co

hasPrivileges

public final CompletableFuture<HasPrivilegesResponse> hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

hasPrivileges

public CompletableFuture<HasPrivilegesResponse> hasPrivileges()

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

See Also:

• Documentation on elastic.co

hasPrivilegesUserProfile

public CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request)

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

See Also:

• Documentation on elastic.co

hasPrivilegesUserProfile

public final CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)

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

See Also:

• Documentation on elastic.co

invalidateApiKey

public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(InvalidateApiKeyRequest request)

Invalidate API keys. 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.

See Also:

• Documentation on elastic.co

invalidateApiKey

public final CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)

Invalidate API keys. 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

See Also:

• Documentation on elastic.co

invalidateApiKey

public CompletableFuture<InvalidateApiKeyResponse> invalidateApiKey()

Invalidate API keys. 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.

See Also:

• Documentation on elastic.co

invalidateToken

public CompletableFuture<InvalidateTokenResponse> invalidateToken(InvalidateTokenRequest request)

Invalidates one or more access tokens or refresh tokens.

See Also:

• Documentation on elastic.co

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 the InvalidateTokenRequest

See Also:

• Documentation on elastic.co

invalidateToken

public CompletableFuture<InvalidateTokenResponse> invalidateToken()

Invalidates one or more access tokens or refresh tokens.

See Also:

• Documentation on elastic.co

putPrivileges

public CompletableFuture<PutPrivilegesResponse> putPrivileges(PutPrivilegesRequest request)

Adds or updates application privileges.

See Also:

• Documentation on elastic.co

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 the PutPrivilegesRequest

See Also:

• Documentation on elastic.co

putPrivileges

public CompletableFuture<PutPrivilegesResponse> putPrivileges()

Adds or updates application privileges.

See Also:

• Documentation on elastic.co

putRole

public CompletableFuture<PutRoleResponse> putRole(PutRoleRequest request)

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.

See Also:

• Documentation on elastic.co

putRole

public final CompletableFuture<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. 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

See Also:

• Documentation on elastic.co

putRoleMapping

public CompletableFuture<PutRoleMappingResponse> putRoleMapping(PutRoleMappingRequest request)

Creates and updates role mappings.

See Also:

• Documentation on elastic.co

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 the PutRoleMappingRequest

See Also:

• Documentation on elastic.co

putUser

public CompletableFuture<PutUserResponse> putUser(PutUserRequest request)

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

See Also:

• Documentation on elastic.co

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 the PutUserRequest

See Also:

• Documentation on elastic.co

queryApiKeys

public CompletableFuture<QueryApiKeysResponse> queryApiKeys(QueryApiKeysRequest request)

Query API keys. Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.

See Also:

• Documentation on elastic.co

queryApiKeys

public final CompletableFuture<QueryApiKeysResponse> queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)

Query API keys. Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.

Parameters:

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

See Also:

• Documentation on elastic.co

queryApiKeys

public CompletableFuture<QueryApiKeysResponse> queryApiKeys()

Query API keys. Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.

See Also:

• Documentation on elastic.co

queryRole

public CompletableFuture<QueryRoleResponse> queryRole(QueryRoleRequest request)

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

See Also:

• Documentation on elastic.co

queryRole

public final CompletableFuture<QueryRoleResponse> queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn)

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

See Also:

• Documentation on elastic.co

queryRole

public CompletableFuture<QueryRoleResponse> queryRole()

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

See Also:

• Documentation on elastic.co

queryUser

public CompletableFuture<QueryUserResponse> queryUser(QueryUserRequest request)

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

See Also:

• Documentation on elastic.co

queryUser

public final CompletableFuture<QueryUserResponse> queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)

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

See Also:

• Documentation on elastic.co

queryUser

public CompletableFuture<QueryUserResponse> queryUser()

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

See Also:

• Documentation on elastic.co

samlAuthenticate

public CompletableFuture<SamlAuthenticateResponse> samlAuthenticate(SamlAuthenticateRequest request)

Submits a SAML Response message to Elasticsearch for consumption.

See Also:

• Documentation on elastic.co

samlAuthenticate

public final CompletableFuture<SamlAuthenticateResponse> samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)

Submits a SAML Response message to Elasticsearch for consumption.

Parameters:

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

See Also:

• Documentation on elastic.co

samlCompleteLogout

public CompletableFuture<BooleanResponse> samlCompleteLogout(SamlCompleteLogoutRequest request)

Verifies the logout response sent from the SAML IdP.

See Also:

• Documentation on elastic.co

samlCompleteLogout

public final CompletableFuture<BooleanResponse> samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)

Verifies the logout response sent from the SAML IdP.

Parameters:

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

See Also:

• Documentation on elastic.co

samlInvalidate

public CompletableFuture<SamlInvalidateResponse> samlInvalidate(SamlInvalidateRequest request)

Submits a SAML LogoutRequest message to Elasticsearch for consumption.

See Also:

• Documentation on elastic.co

samlInvalidate

public final CompletableFuture<SamlInvalidateResponse> samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn)

Submits a SAML LogoutRequest message to Elasticsearch for consumption.

Parameters:

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

See Also:

• Documentation on elastic.co

samlLogout

public CompletableFuture<SamlLogoutResponse> samlLogout(SamlLogoutRequest request)

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

See Also:

• Documentation on elastic.co

samlLogout

public final CompletableFuture<SamlLogoutResponse> samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public CompletableFuture<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.

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public final CompletableFuture<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.

Parameters:

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

See Also:

• Documentation on elastic.co

samlPrepareAuthentication

public CompletableFuture<SamlPrepareAuthenticationResponse> samlPrepareAuthentication()

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

See Also:

• Documentation on elastic.co

samlServiceProviderMetadata

public CompletableFuture<SamlServiceProviderMetadataResponse> samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request)

Generate SAML metadata for a SAML 2.0 Service Provider.

See Also:

• Documentation on elastic.co

samlServiceProviderMetadata

public final CompletableFuture<SamlServiceProviderMetadataResponse> samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)

Generate SAML metadata for a SAML 2.0 Service Provider.

Parameters:

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

See Also:

• Documentation on elastic.co

suggestUserProfiles

public CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles(SuggestUserProfilesRequest request)

Get suggestions for user profiles that match specified search criteria.

See Also:

• Documentation on elastic.co

suggestUserProfiles

public final CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)

Get suggestions for user profiles that match specified search criteria.

Parameters:

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

See Also:

• Documentation on elastic.co

suggestUserProfiles

public CompletableFuture<SuggestUserProfilesResponse> suggestUserProfiles()

Get suggestions for user profiles that match specified search criteria.

See Also:

• Documentation on elastic.co

updateApiKey

public CompletableFuture<UpdateApiKeyResponse> updateApiKey(UpdateApiKeyRequest request)

Update an API key. 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.

See Also:

• Documentation on elastic.co

updateApiKey

public final CompletableFuture<UpdateApiKeyResponse> updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)

Update an API key. 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

See Also:

• Documentation on elastic.co

updateUserProfileData

public CompletableFuture<UpdateUserProfileDataResponse> updateUserProfileData(UpdateUserProfileDataRequest request)

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

See Also:

• Documentation on elastic.co

updateUserProfileData

public final CompletableFuture<UpdateUserProfileDataResponse> updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)

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

See Also:

• Documentation on elastic.co