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)	Activate a user profile.
final CompletableFuture<ActivateUserProfileResponse>	activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)	Activate a user profile.
CompletableFuture<AuthenticateResponse>	authenticate()	Authenticate a user.
CompletableFuture<BulkDeleteRoleResponse>	bulkDeleteRole(BulkDeleteRoleRequest request)	Bulk delete roles.
final CompletableFuture<BulkDeleteRoleResponse>	bulkDeleteRole(Function<BulkDeleteRoleRequest.Builder,ObjectBuilder<BulkDeleteRoleRequest>> fn)	Bulk delete roles.
CompletableFuture<BulkPutRoleResponse>	bulkPutRole(BulkPutRoleRequest request)	Bulk create or update roles.
final CompletableFuture<BulkPutRoleResponse>	bulkPutRole(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn)	Bulk create or update roles.
CompletableFuture<ChangePasswordResponse>	changePassword()	Change passwords.
CompletableFuture<ChangePasswordResponse>	changePassword(ChangePasswordRequest request)	Change passwords.
final CompletableFuture<ChangePasswordResponse>	changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)	Change passwords.
CompletableFuture<ClearApiKeyCacheResponse>	clearApiKeyCache(ClearApiKeyCacheRequest request)	Clear the API key cache.
final CompletableFuture<ClearApiKeyCacheResponse>	clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)	Clear the API key cache.
CompletableFuture<ClearCachedPrivilegesResponse>	clearCachedPrivileges(ClearCachedPrivilegesRequest request)	Clear the privileges cache.
final CompletableFuture<ClearCachedPrivilegesResponse>	clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)	Clear the privileges cache.
CompletableFuture<ClearCachedRealmsResponse>	clearCachedRealms(ClearCachedRealmsRequest request)	Clear the user cache.
final CompletableFuture<ClearCachedRealmsResponse>	clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)	Clear the user cache.
CompletableFuture<ClearCachedRolesResponse>	clearCachedRoles(ClearCachedRolesRequest request)	Clear the roles cache.
final CompletableFuture<ClearCachedRolesResponse>	clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)	Clear the roles cache.
CompletableFuture<ClearCachedServiceTokensResponse>	clearCachedServiceTokens(ClearCachedServiceTokensRequest request)	Clear service account token caches.
final CompletableFuture<ClearCachedServiceTokensResponse>	clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)	Clear 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<CreateCrossClusterApiKeyResponse>	createCrossClusterApiKey(CreateCrossClusterApiKeyRequest request)	Create a cross-cluster API key.
final CompletableFuture<CreateCrossClusterApiKeyResponse>	createCrossClusterApiKey(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> fn)	Create a cross-cluster API key.
CompletableFuture<CreateServiceTokenResponse>	createServiceToken(CreateServiceTokenRequest request)	Create a service account token.
final CompletableFuture<CreateServiceTokenResponse>	createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)	Create a service account token.
CompletableFuture<DeletePrivilegesResponse>	deletePrivileges(DeletePrivilegesRequest request)	Delete application privileges.
final CompletableFuture<DeletePrivilegesResponse>	deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)	Delete application privileges.
CompletableFuture<DeleteRoleResponse>	deleteRole(DeleteRoleRequest request)	Delete roles.
final CompletableFuture<DeleteRoleResponse>	deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)	Delete roles.
CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(DeleteRoleMappingRequest request)	Delete role mappings.
final CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)	Delete role mappings.
CompletableFuture<DeleteServiceTokenResponse>	deleteServiceToken(DeleteServiceTokenRequest request)	Delete service account tokens.
final CompletableFuture<DeleteServiceTokenResponse>	deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)	Delete service account tokens.
CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest request)	Delete users.
final CompletableFuture<DeleteUserResponse>	deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)	Delete users.
CompletableFuture<DisableUserResponse>	disableUser(DisableUserRequest request)	Disable users.
final CompletableFuture<DisableUserResponse>	disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)	Disable users.
CompletableFuture<DisableUserProfileResponse>	disableUserProfile(DisableUserProfileRequest request)	Disable a user profile.
final CompletableFuture<DisableUserProfileResponse>	disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)	Disable a user profile.
CompletableFuture<EnableUserResponse>	enableUser(EnableUserRequest request)	Enable users.
final CompletableFuture<EnableUserResponse>	enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)	Enable users.
CompletableFuture<EnableUserProfileResponse>	enableUserProfile(EnableUserProfileRequest request)	Enable a user profile.
final CompletableFuture<EnableUserProfileResponse>	enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)	Enable a user profile.
CompletableFuture<EnrollKibanaResponse>	enrollKibana()	Enroll Kibana.
CompletableFuture<EnrollNodeResponse>	enrollNode()	Enroll a node.
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()	Get builtin privileges.
CompletableFuture<GetPrivilegesResponse>	getPrivileges()	Get application privileges.
CompletableFuture<GetPrivilegesResponse>	getPrivileges(GetPrivilegesRequest request)	Get application privileges.
final CompletableFuture<GetPrivilegesResponse>	getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)	Get application privileges.
CompletableFuture<GetRoleResponse>	getRole()	Get roles.
CompletableFuture<GetRoleResponse>	getRole(GetRoleRequest request)	Get roles.
final CompletableFuture<GetRoleResponse>	getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)	Get roles.
CompletableFuture<GetRoleMappingResponse>	getRoleMapping()	Get role mappings.
CompletableFuture<GetRoleMappingResponse>	getRoleMapping(GetRoleMappingRequest request)	Get role mappings.
final CompletableFuture<GetRoleMappingResponse>	getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)	Get role mappings.
CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts()	Get service accounts.
CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts(GetServiceAccountsRequest request)	Get service accounts.
final CompletableFuture<GetServiceAccountsResponse>	getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)	Get service accounts.
CompletableFuture<GetServiceCredentialsResponse>	getServiceCredentials(GetServiceCredentialsRequest request)	Get service account credentials.
final CompletableFuture<GetServiceCredentialsResponse>	getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)	Get service account credentials.
CompletableFuture<GetTokenResponse>	getToken()	Get a token.
CompletableFuture<GetTokenResponse>	getToken(GetTokenRequest request)	Get a token.
final CompletableFuture<GetTokenResponse>	getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)	Get a token.
CompletableFuture<GetUserResponse>	getUser()	Get users.
CompletableFuture<GetUserResponse>	getUser(GetUserRequest request)	Get users.
final CompletableFuture<GetUserResponse>	getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)	Get users.
CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges()	Get user privileges.
CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges(GetUserPrivilegesRequest request)	Get user privileges.
final CompletableFuture<GetUserPrivilegesResponse>	getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)	Get user privileges.
CompletableFuture<GetUserProfileResponse>	getUserProfile(GetUserProfileRequest request)	Get a user profile.
final CompletableFuture<GetUserProfileResponse>	getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)	Get a user profile.
CompletableFuture<GrantApiKeyResponse>	grantApiKey(GrantApiKeyRequest request)	Grant an API key.
final CompletableFuture<GrantApiKeyResponse>	grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)	Grant an API key.
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)	Check user profile privileges.
final CompletableFuture<HasPrivilegesUserProfileResponse>	hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)	Check user profile 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()	Invalidate a token.
CompletableFuture<InvalidateTokenResponse>	invalidateToken(InvalidateTokenRequest request)	Invalidate a token.
final CompletableFuture<InvalidateTokenResponse>	invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)	Invalidate a token.
CompletableFuture<PutPrivilegesResponse>	putPrivileges()	Create or update application privileges.
CompletableFuture<PutPrivilegesResponse>	putPrivileges(PutPrivilegesRequest request)	Create or update application privileges.
final CompletableFuture<PutPrivilegesResponse>	putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)	Create or update application privileges.
CompletableFuture<PutRoleResponse>	putRole(PutRoleRequest request)	Create or update roles.
final CompletableFuture<PutRoleResponse>	putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)	Create or update roles.
CompletableFuture<PutRoleMappingResponse>	putRoleMapping(PutRoleMappingRequest request)	Create or update role mappings.
final CompletableFuture<PutRoleMappingResponse>	putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)	Create or update role mappings.
CompletableFuture<PutUserResponse>	putUser(PutUserRequest request)	Create or update users.
final CompletableFuture<PutUserResponse>	putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)	Create or update users.
CompletableFuture<QueryApiKeysResponse>	queryApiKeys()	Find API keys with a query.
CompletableFuture<QueryApiKeysResponse>	queryApiKeys(QueryApiKeysRequest request)	Find API keys with a query.
final CompletableFuture<QueryApiKeysResponse>	queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)	Find API keys with a query.
CompletableFuture<QueryRoleResponse>	queryRole()	Find roles with a query.
CompletableFuture<QueryRoleResponse>	queryRole(QueryRoleRequest request)	Find roles with a query.
final CompletableFuture<QueryRoleResponse>	queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn)	Find roles with a query.
CompletableFuture<QueryUserResponse>	queryUser()	Find users with a query.
CompletableFuture<QueryUserResponse>	queryUser(QueryUserRequest request)	Find users with a query.
final CompletableFuture<QueryUserResponse>	queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)	Find users with a query.
CompletableFuture<SamlAuthenticateResponse>	samlAuthenticate(SamlAuthenticateRequest request)	Authenticate SAML.
final CompletableFuture<SamlAuthenticateResponse>	samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)	Authenticate SAML.
CompletableFuture<BooleanResponse>	samlCompleteLogout(SamlCompleteLogoutRequest request)	Logout of SAML completely.
final CompletableFuture<BooleanResponse>	samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)	Logout of SAML completely.
CompletableFuture<SamlInvalidateResponse>	samlInvalidate(SamlInvalidateRequest request)	Invalidate SAML.
final CompletableFuture<SamlInvalidateResponse>	samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn)	Invalidate SAML.
CompletableFuture<SamlLogoutResponse>	samlLogout(SamlLogoutRequest request)	Logout of SAML.
final CompletableFuture<SamlLogoutResponse>	samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)	Logout of SAML.
CompletableFuture<SamlPrepareAuthenticationResponse>	samlPrepareAuthentication()	Prepare SAML authentication.
CompletableFuture<SamlPrepareAuthenticationResponse>	samlPrepareAuthentication(SamlPrepareAuthenticationRequest request)	Prepare SAML authentication.
final CompletableFuture<SamlPrepareAuthenticationResponse>	samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)	Prepare SAML authentication.
CompletableFuture<SamlServiceProviderMetadataResponse>	samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request)	Create SAML service provider metadata.
final CompletableFuture<SamlServiceProviderMetadataResponse>	samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)	Create SAML service provider metadata.
CompletableFuture<SuggestUserProfilesResponse>	suggestUserProfiles()	Suggest a user profile.
CompletableFuture<SuggestUserProfilesResponse>	suggestUserProfiles(SuggestUserProfilesRequest request)	Suggest a user profile.
final CompletableFuture<SuggestUserProfilesResponse>	suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)	Suggest a user profile.
CompletableFuture<UpdateApiKeyResponse>	updateApiKey(UpdateApiKeyRequest request)	Update an API key.
final CompletableFuture<UpdateApiKeyResponse>	updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)	Update an API key.
CompletableFuture<UpdateCrossClusterApiKeyResponse>	updateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request)	Update a cross-cluster API key.
final CompletableFuture<UpdateCrossClusterApiKeyResponse>	updateCrossClusterApiKey(Function<UpdateCrossClusterApiKeyRequest.Builder,ObjectBuilder<UpdateCrossClusterApiKeyRequest>> fn)	Update a cross-cluster API key.
CompletableFuture<UpdateUserProfileDataResponse>	updateUserProfileData(UpdateUserProfileDataRequest request)	Update user profile data.
final CompletableFuture<UpdateUserProfileDataResponse>	updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)	Update user profile data.
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)

Activate a user profile.

Create or update 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)

Activate a user profile.

Create or update 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)

Bulk delete roles.

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)

Bulk delete roles.

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)

Bulk create or update roles.

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)

Bulk create or update roles.

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)

Change passwords.

Change 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)

Change passwords.

Change 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()

Change passwords.

Change 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)

Clear the API key cache.

Evict 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)

Clear the API key cache.

Evict 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)

Clear the privileges cache.

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.

See Also:

• Documentation on elastic.co

clearCachedPrivileges

public final CompletableFuture<ClearCachedPrivilegesResponse> clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)

Clear the privileges cache.

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.

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)

Clear the user cache.

Evict users from the user cache. You 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)

Clear the user cache.

Evict users from the user cache. You 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)

Clear the roles cache.

Evict roles from the native role cache.

See Also:

• Documentation on elastic.co

clearCachedRoles

public final CompletableFuture<ClearCachedRolesResponse> clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)

Clear the roles cache.

Evict 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)

Clear service account token caches.

Evict a subset of all entries from the service account token caches.

See Also:

• Documentation on elastic.co

clearCachedServiceTokens

public final CompletableFuture<ClearCachedServiceTokensResponse> clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)

Clear service account token caches.

Evict a subset of all entries 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.

Create 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.

Create 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.

Create 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

createCrossClusterApiKey

public CompletableFuture<CreateCrossClusterApiKeyResponse> createCrossClusterApiKey(CreateCrossClusterApiKeyRequest request)

Create a cross-cluster API key.

Create an API key of the cross_cluster type for the API key based remote cluster access. A cross_cluster API key cannot be used to authenticate through the REST interface.

IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.

Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.

NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property.

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.

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

Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.

See Also:

• Documentation on elastic.co

createCrossClusterApiKey

public final CompletableFuture<CreateCrossClusterApiKeyResponse> createCrossClusterApiKey(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> fn)

Create a cross-cluster API key.

Create an API key of the cross_cluster type for the API key based remote cluster access. A cross_cluster API key cannot be used to authenticate through the REST interface.

IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.

Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.

NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property.

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.

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

Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.

Parameters:

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

See Also:

• Documentation on elastic.co

createServiceToken

public CompletableFuture<CreateServiceTokenResponse> createServiceToken(CreateServiceTokenRequest request)

Create a service account token.

Create 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)

Create a service account token.

Create 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)

Delete application privileges.

See Also:

• Documentation on elastic.co

deletePrivileges

public final CompletableFuture<DeletePrivilegesResponse> deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)

Delete 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)

Delete roles.

Delete roles in the native realm.

See Also:

• Documentation on elastic.co

deleteRole

public final CompletableFuture<DeleteRoleResponse> deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)

Delete roles.

Delete 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)

Delete role mappings.

See Also:

• Documentation on elastic.co

deleteRoleMapping

public final CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)

Delete 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)

Delete service account tokens.

Delete service account tokens for a service in a specified namespace.

See Also:

• Documentation on elastic.co

deleteServiceToken

public final CompletableFuture<DeleteServiceTokenResponse> deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)

Delete service account tokens.

Delete service account tokens for a service in a specified namespace.

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)

Delete users.

Delete users from the native realm.

See Also:

• Documentation on elastic.co

deleteUser

public final CompletableFuture<DeleteUserResponse> deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)

Delete users.

Delete 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)

Disable users.

Disable users in the native realm.

See Also:

• Documentation on elastic.co

disableUser

public final CompletableFuture<DisableUserResponse> disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)

Disable users.

Disable 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)

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

See Also:

• Documentation on elastic.co

disableUserProfile

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

Disable a user profile.

Disable user profiles so that they are 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)

Enable users.

Enable users in the native realm.

See Also:

• Documentation on elastic.co

enableUser

public final CompletableFuture<EnableUserResponse> enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)

Enable users.

Enable 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)

Enable a user profile.

Enable user profiles to make them visible in user profile searches.

See Also:

• Documentation on elastic.co

enableUserProfile

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

Enable a user profile.

Enable user profiles to make them 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()

Enroll Kibana.

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

See Also:

• Documentation on elastic.co

enrollNode

public CompletableFuture<EnrollNodeResponse> enrollNode()

Enroll a node.

Enroll a new node to allow it 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()

Get builtin privileges.

Get 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)

Get application privileges.

See Also:

• Documentation on elastic.co

getPrivileges

public final CompletableFuture<GetPrivilegesResponse> getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)

Get 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()

Get application privileges.

See Also:

• Documentation on elastic.co

getRole

public CompletableFuture<GetRoleResponse> getRole(GetRoleRequest request)

Get roles.

Get roles in the native realm. 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)

Get roles.

Get roles in the native realm. 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()

Get roles.

Get roles in the native realm. 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)

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

See Also:

• Documentation on elastic.co

getRoleMapping

public final CompletableFuture<GetRoleMappingResponse> getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

Parameters:

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

See Also:

• Documentation on elastic.co

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping()

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts(GetServiceAccountsRequest request)

Get service accounts.

Get a list of service accounts that match the provided path parameters.

See Also:

• Documentation on elastic.co

getServiceAccounts

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

Get service accounts.

Get a list of service accounts that match the provided path parameters.

Parameters:

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

See Also:

• Documentation on elastic.co

getServiceAccounts

public CompletableFuture<GetServiceAccountsResponse> getServiceAccounts()

Get service accounts.

Get a list of service accounts that match the provided path parameters.

See Also:

• Documentation on elastic.co

getServiceCredentials

public CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(GetServiceCredentialsRequest request)

Get service account credentials.

See Also:

• Documentation on elastic.co

getServiceCredentials

public final CompletableFuture<GetServiceCredentialsResponse> getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)

Get service account credentials.

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)

Get a token.

Create 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)

Get a token.

Create 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()

Get a token.

Create a bearer token for access without requiring basic authentication.

See Also:

• Documentation on elastic.co

getUser

public CompletableFuture<GetUserResponse> getUser(GetUserRequest request)

Get users.

Get 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)

Get users.

Get 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()

Get users.

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

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(GetUserPrivilegesRequest request)

Get user privileges.

See Also:

• Documentation on elastic.co

getUserPrivileges

public final CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)

Get user privileges.

Parameters:

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

See Also:

• Documentation on elastic.co

getUserPrivileges

public CompletableFuture<GetUserPrivilegesResponse> getUserPrivileges()

Get user privileges.

See Also:

• Documentation on elastic.co

getUserProfile

public CompletableFuture<GetUserProfileResponse> getUserProfile(GetUserProfileRequest request)

Get a user profile.

Get 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)

Get a user profile.

Get 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)

Grant an API key.

Create an API key on behalf of another user. This API is similar to the create API keys API, 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)

Grant an API key.

Create an API key on behalf of another user. This API is similar to the create API keys API, 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.

Determine 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.

Determine 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.

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

See Also:

• Documentation on elastic.co

hasPrivilegesUserProfile

public CompletableFuture<HasPrivilegesUserProfileResponse> hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request)

Check user profile privileges.

Determine whether the users associated with the specified user 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)

Check user profile privileges.

Determine whether the users associated with the specified user 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.

This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. 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, that is to say 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.

This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. 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, that is to say 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.

This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. 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, that is to say 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)

Invalidate a token.

The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the xpack.security.authc.token.timeout setting.

The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.

See Also:

• Documentation on elastic.co

invalidateToken

public final CompletableFuture<InvalidateTokenResponse> invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)

Invalidate a token.

The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the xpack.security.authc.token.timeout setting.

The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.

Parameters:

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

See Also:

• Documentation on elastic.co

invalidateToken

public CompletableFuture<InvalidateTokenResponse> invalidateToken()

Invalidate a token.

The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the xpack.security.authc.token.timeout setting.

The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.

See Also:

• Documentation on elastic.co

putPrivileges

public CompletableFuture<PutPrivilegesResponse> putPrivileges(PutPrivilegesRequest request)

Create or update application privileges.

See Also:

• Documentation on elastic.co

putPrivileges

public final CompletableFuture<PutPrivilegesResponse> putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)

Create or update 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()

Create or update application privileges.

See Also:

• Documentation on elastic.co

putRole

public CompletableFuture<PutRoleResponse> putRole(PutRoleRequest request)

Create or update roles.

The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless.

See Also:

• Documentation on elastic.co

putRole

public final CompletableFuture<PutRoleResponse> putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)

Create or update roles.

The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless.

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)

Create or update role mappings.

Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.

This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.

See Also:

• Documentation on elastic.co

putRoleMapping

public final CompletableFuture<PutRoleMappingResponse> putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)

Create or update role mappings.

Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.

This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.

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)

Create or update users.

A password is required for adding a new user but is optional when updating an existing user. To change a user’s password without updating any other fields, use the change password API.

See Also:

• Documentation on elastic.co

putUser

public final CompletableFuture<PutUserResponse> putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)

Create or update users.

A password is required for adding a new user but is optional when updating an existing user. To change a user’s password without updating any other fields, use the change password API.

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)

Find API keys with a query.

Get 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)

Find API keys with a query.

Get 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()

Find API keys with a query.

Get 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)

Find roles with a query.

Get 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)

Find roles with a query.

Get 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()

Find roles with a query.

Get 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)

Find users with a query.

Get 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)

Find users with a query.

Get 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()

Find users with a query.

Get 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)

Authenticate SAML.

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)

Authenticate SAML.

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)

Logout of SAML completely.

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)

Logout of SAML completely.

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)

Invalidate SAML.

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)

Invalidate SAML.

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)

Logout of SAML.

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)

Logout of SAML.

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)

Prepare SAML authentication.

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)

Prepare SAML authentication.

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()

Prepare SAML authentication.

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)

Create SAML service provider metadata.

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)

Create SAML service provider metadata.

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)

Suggest a user profile.

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)

Suggest a user profile.

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()

Suggest a user profile.

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

updateCrossClusterApiKey

public CompletableFuture<UpdateCrossClusterApiKeyResponse> updateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request)

Update a cross-cluster API key.

Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.

See Also:

• Documentation on elastic.co

updateCrossClusterApiKey

public final CompletableFuture<UpdateCrossClusterApiKeyResponse> updateCrossClusterApiKey(Function<UpdateCrossClusterApiKeyRequest.Builder,ObjectBuilder<UpdateCrossClusterApiKeyRequest>> fn)

Update a cross-cluster API key.

Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.

Parameters:

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

See Also:

• Documentation on elastic.co

updateUserProfileData

public CompletableFuture<UpdateUserProfileDataResponse> updateUserProfileData(UpdateUserProfileDataRequest request)

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

See Also:

• Documentation on elastic.co

updateUserProfileData

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

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

Parameters:

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

See Also:

• Documentation on elastic.co