Package co.elastic.clients.elasticsearch.security

Class ElasticsearchSecurityClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.security.ElasticsearchSecurityClient

public class ElasticsearchSecurityClient
extends ApiClient

Client for the security namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchSecurityClient(Transport transport)

Method Summary

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

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchSecurityClient

public ElasticsearchSecurityClient(Transport transport)

Method Details

authenticate

public AuthenticateResponse authenticate()
                                  throws java.io.IOException

Enables authentication as a user and retrieve information about the authenticated user.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

changePassword

public ChangePasswordResponse changePassword(ChangePasswordRequest request)
                                      throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

changePassword

public final ChangePasswordResponse changePassword(java.util.function.Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)
                                            throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearApiKeyCache

public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request)
                                          throws java.io.IOException

Clear a subset or all entries from the API key cache.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearApiKeyCache

public final ClearApiKeyCacheResponse clearApiKeyCache(java.util.function.Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)
                                                throws java.io.IOException

Clear a subset or all entries from the API key cache.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedPrivileges

public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivilegesRequest request)
                                                    throws java.io.IOException

Evicts application privileges from the native application privileges cache.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedPrivileges

public final ClearCachedPrivilegesResponse clearCachedPrivileges(java.util.function.Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)
                                                          throws java.io.IOException

Evicts application privileges from the native application privileges cache.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedRealms

public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest request)
                                            throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedRealms

public final ClearCachedRealmsResponse clearCachedRealms(java.util.function.Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)
                                                  throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedRoles

public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request)
                                          throws java.io.IOException

Evicts roles from the native role cache.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedRoles

public final ClearCachedRolesResponse clearCachedRoles(java.util.function.Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)
                                                throws java.io.IOException

Evicts roles from the native role cache.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedServiceTokens

public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServiceTokensRequest request)
                                                          throws java.io.IOException

Evicts tokens from the service account token caches.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

clearCachedServiceTokens

public final ClearCachedServiceTokensResponse clearCachedServiceTokens(java.util.function.Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)
                                                                throws java.io.IOException

Evicts tokens from the service account token caches.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

createApiKey

public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request)
                                  throws java.io.IOException

Creates an API key for access without requiring basic authentication.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

createApiKey

public final CreateApiKeyResponse createApiKey(java.util.function.Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)
                                        throws java.io.IOException

Creates an API key for access without requiring basic authentication.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

createServiceToken

public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest request)
                                              throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

createServiceToken

public final CreateServiceTokenResponse createServiceToken(java.util.function.Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)
                                                    throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deletePrivileges

public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request)
                                          throws java.io.IOException

Removes application privileges.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deletePrivileges

public final DeletePrivilegesResponse deletePrivileges(java.util.function.Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)
                                                throws java.io.IOException

Removes application privileges.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteRole

public DeleteRoleResponse deleteRole(DeleteRoleRequest request)
                              throws java.io.IOException

Removes roles in the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteRole

public final DeleteRoleResponse deleteRole(java.util.function.Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)
                                    throws java.io.IOException

Removes roles in the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteRoleMapping

public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request)
                                            throws java.io.IOException

Removes role mappings.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteRoleMapping

public final DeleteRoleMappingResponse deleteRoleMapping(java.util.function.Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)
                                                  throws java.io.IOException

Removes role mappings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteServiceToken

public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest request)
                                              throws java.io.IOException

Deletes a service account token.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteServiceToken

public final DeleteServiceTokenResponse deleteServiceToken(java.util.function.Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)
                                                    throws java.io.IOException

Deletes a service account token.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteUser

public DeleteUserResponse deleteUser(DeleteUserRequest request)
                              throws java.io.IOException

Deletes users from the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteUser

public final DeleteUserResponse deleteUser(java.util.function.Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)
                                    throws java.io.IOException

Deletes users from the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

disableUser

public DisableUserResponse disableUser(DisableUserRequest request)
                                throws java.io.IOException

Disables users in the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

disableUser

public final DisableUserResponse disableUser(java.util.function.Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)
                                      throws java.io.IOException

Disables users in the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

enableUser

public EnableUserResponse enableUser(EnableUserRequest request)
                              throws java.io.IOException

Enables users in the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

enableUser

public final EnableUserResponse enableUser(java.util.function.Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)
                                    throws java.io.IOException

Enables users in the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getApiKey

public GetApiKeyResponse getApiKey(GetApiKeyRequest request)
                            throws java.io.IOException

Retrieves information for one or more API keys.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getApiKey

public final GetApiKeyResponse getApiKey(java.util.function.Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)
                                  throws java.io.IOException

Retrieves information for one or more API keys.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getBuiltinPrivileges

public GetBuiltinPrivilegesResponse getBuiltinPrivileges()
                                                  throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getPrivileges

public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request)
                                    throws java.io.IOException

Retrieves application privileges.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getPrivileges

public final GetPrivilegesResponse getPrivileges(java.util.function.Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)
                                          throws java.io.IOException

Retrieves application privileges.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRole

public GetRoleResponse getRole(GetRoleRequest request)
                        throws java.io.IOException

Retrieves roles in the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRole

public final GetRoleResponse getRole(java.util.function.Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)
                              throws java.io.IOException

Retrieves roles in the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRoleMapping

public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request)
                                      throws java.io.IOException

Retrieves role mappings.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getRoleMapping

public final GetRoleMappingResponse getRoleMapping(java.util.function.Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)
                                            throws java.io.IOException

Retrieves role mappings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getServiceAccounts

public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest request)
                                              throws java.io.IOException

Retrieves information about service accounts.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getServiceAccounts

public final GetServiceAccountsResponse getServiceAccounts(java.util.function.Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)
                                                    throws java.io.IOException

Retrieves information about service accounts.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getServiceCredentials

public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentialsRequest request)
                                                    throws java.io.IOException

Retrieves information of all service credentials for a service account.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getServiceCredentials

public final GetServiceCredentialsResponse getServiceCredentials(java.util.function.Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)
                                                          throws java.io.IOException

Retrieves information of all service credentials for a service account.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getToken

public GetTokenResponse getToken(GetTokenRequest request)
                          throws java.io.IOException

Creates a bearer token for access without requiring basic authentication.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getToken

public final GetTokenResponse getToken(java.util.function.Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)
                                throws java.io.IOException

Creates a bearer token for access without requiring basic authentication.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getUser

public GetUserResponse getUser(GetUserRequest request)
                        throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getUser

public final GetUserResponse getUser(java.util.function.Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)
                              throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getUserPrivileges

public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest request)
                                            throws java.io.IOException

Retrieves security privileges for the logged in user.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getUserPrivileges

public final GetUserPrivilegesResponse getUserPrivileges(java.util.function.Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)
                                                  throws java.io.IOException

Retrieves security privileges for the logged in user.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

grantApiKey

public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request)
                                throws java.io.IOException

Creates an API key on behalf of another user.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

grantApiKey

public final GrantApiKeyResponse grantApiKey(java.util.function.Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)
                                      throws java.io.IOException

Creates an API key on behalf of another user.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

hasPrivileges

public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request)
                                    throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

hasPrivileges

public final HasPrivilegesResponse hasPrivileges(java.util.function.Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)
                                          throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

invalidateApiKey

public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request)
                                          throws java.io.IOException

Invalidates one or more API keys.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

invalidateApiKey

public final InvalidateApiKeyResponse invalidateApiKey(java.util.function.Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)
                                                throws java.io.IOException

Invalidates one or more API keys.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

invalidateToken

public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request)
                                        throws java.io.IOException

Invalidates one or more access tokens or refresh tokens.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

invalidateToken

public final InvalidateTokenResponse invalidateToken(java.util.function.Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)
                                              throws java.io.IOException

Invalidates one or more access tokens or refresh tokens.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putPrivileges

public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request)
                                    throws java.io.IOException

Adds or updates application privileges.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putPrivileges

public final PutPrivilegesResponse putPrivileges(java.util.function.Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)
                                          throws java.io.IOException

Adds or updates application privileges.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putRole

public PutRoleResponse putRole(PutRoleRequest request)
                        throws java.io.IOException

Adds and updates roles in the native realm.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putRole

public final PutRoleResponse putRole(java.util.function.Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)
                              throws java.io.IOException

Adds and updates roles in the native realm.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putRoleMapping

public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request)
                                      throws java.io.IOException

Creates and updates role mappings.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putRoleMapping

public final PutRoleMappingResponse putRoleMapping(java.util.function.Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)
                                            throws java.io.IOException

Creates and updates role mappings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putUser

public PutUserResponse putUser(PutUserRequest request)
                        throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putUser

public final PutUserResponse putUser(java.util.function.Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)
                              throws java.io.IOException

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co