Class ElasticsearchSecurityClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>
co.elastic.clients.elasticsearch.security.ElasticsearchSecurityClient
public class ElasticsearchSecurityClient
extends ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>
Client for the security namespace.
-
Field Summary
Fields inherited from class co.elastic.clients.ApiClient
transport, transportOptions
-
Constructor Summary
ConstructorDescriptionElasticsearchSecurityClient
(ElasticsearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionCreates or updates the user profile on behalf of another user.activateUserProfile
(Function<ActivateUserProfileRequest.Builder, ObjectBuilder<ActivateUserProfileRequest>> fn) Creates or updates the user profile on behalf of another user.Enables authentication as a user and retrieve information about the authenticated user.Changes the passwords of users in the native realm and built-in users.changePassword
(ChangePasswordRequest request) Changes the passwords of users in the native realm and built-in users.final ChangePasswordResponse
Changes the passwords of users in the native realm and built-in users.clearApiKeyCache
(ClearApiKeyCacheRequest request) Clear a subset or all entries from the API key cache.final ClearApiKeyCacheResponse
clearApiKeyCache
(Function<ClearApiKeyCacheRequest.Builder, ObjectBuilder<ClearApiKeyCacheRequest>> fn) Clear a subset or all entries from the API key cache.Evicts application privileges from the native application privileges cache.clearCachedPrivileges
(Function<ClearCachedPrivilegesRequest.Builder, ObjectBuilder<ClearCachedPrivilegesRequest>> fn) Evicts application privileges from the native application privileges cache.Evicts users from the user cache.clearCachedRealms
(Function<ClearCachedRealmsRequest.Builder, ObjectBuilder<ClearCachedRealmsRequest>> fn) Evicts users from the user cache.clearCachedRoles
(ClearCachedRolesRequest request) Evicts roles from the native role cache.final ClearCachedRolesResponse
clearCachedRoles
(Function<ClearCachedRolesRequest.Builder, ObjectBuilder<ClearCachedRolesRequest>> fn) Evicts roles from the native role cache.Evicts tokens from the service account token caches.clearCachedServiceTokens
(Function<ClearCachedServiceTokensRequest.Builder, ObjectBuilder<ClearCachedServiceTokensRequest>> fn) Evicts tokens from the service account token caches.Creates an API key for access without requiring basic authentication.createApiKey
(CreateApiKeyRequest request) Creates an API key for access without requiring basic authentication.final CreateApiKeyResponse
Creates an API key for access without requiring basic authentication.Creates a service account token for access without requiring basic authentication.createServiceToken
(Function<CreateServiceTokenRequest.Builder, ObjectBuilder<CreateServiceTokenRequest>> fn) Creates a service account token for access without requiring basic authentication.deletePrivileges
(DeletePrivilegesRequest request) Removes application privileges.final DeletePrivilegesResponse
deletePrivileges
(Function<DeletePrivilegesRequest.Builder, ObjectBuilder<DeletePrivilegesRequest>> fn) Removes application privileges.deleteRole
(DeleteRoleRequest request) Removes roles in the native realm.final DeleteRoleResponse
Removes roles in the native realm.Removes role mappings.deleteRoleMapping
(Function<DeleteRoleMappingRequest.Builder, ObjectBuilder<DeleteRoleMappingRequest>> fn) Removes role mappings.Deletes a service account token.deleteServiceToken
(Function<DeleteServiceTokenRequest.Builder, ObjectBuilder<DeleteServiceTokenRequest>> fn) Deletes a service account token.deleteUser
(DeleteUserRequest request) Deletes users from the native realm.final DeleteUserResponse
Deletes users from the native realm.disableUser
(DisableUserRequest request) Disables users in the native realm.final DisableUserResponse
Disables users in the native realm.Disables a user profile so it's not visible in user profile searches.disableUserProfile
(Function<DisableUserProfileRequest.Builder, ObjectBuilder<DisableUserProfileRequest>> fn) Disables a user profile so it's not visible in user profile searches.enableUser
(EnableUserRequest request) Enables users in the native realm.final EnableUserResponse
Enables users in the native realm.Enables a user profile so it's visible in user profile searches.enableUserProfile
(Function<EnableUserProfileRequest.Builder, ObjectBuilder<EnableUserProfileRequest>> fn) Enables a user profile so it's visible in user profile searches.Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.Allows a new node to enroll to an existing cluster with security enabled.Retrieves information for one or more API keys.getApiKey
(GetApiKeyRequest request) Retrieves information for one or more API keys.final GetApiKeyResponse
Retrieves information for one or more API keys.Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.Retrieves application privileges.getPrivileges
(GetPrivilegesRequest request) Retrieves application privileges.final GetPrivilegesResponse
Retrieves application privileges.getRole()
Retrieves roles in the native realm.getRole
(GetRoleRequest request) Retrieves roles in the native realm.final GetRoleResponse
Retrieves roles in the native realm.Retrieves role mappings.getRoleMapping
(GetRoleMappingRequest request) Retrieves role mappings.final GetRoleMappingResponse
Retrieves role mappings.Retrieves information about service accounts.Retrieves information about service accounts.getServiceAccounts
(Function<GetServiceAccountsRequest.Builder, ObjectBuilder<GetServiceAccountsRequest>> fn) Retrieves information about service accounts.Retrieves information of all service credentials for a service account.getServiceCredentials
(Function<GetServiceCredentialsRequest.Builder, ObjectBuilder<GetServiceCredentialsRequest>> fn) Retrieves information of all service credentials for a service account.getToken()
Creates a bearer token for access without requiring basic authentication.getToken
(GetTokenRequest request) Creates a bearer token for access without requiring basic authentication.final GetTokenResponse
Creates a bearer token for access without requiring basic authentication.getUser()
Retrieves information about users in the native realm and built-in users.getUser
(GetUserRequest request) Retrieves information about users in the native realm and built-in users.final GetUserResponse
Retrieves information about users in the native realm and built-in users.Retrieves security privileges for the logged in user.Retrieves security privileges for the logged in user.getUserPrivileges
(Function<GetUserPrivilegesRequest.Builder, ObjectBuilder<GetUserPrivilegesRequest>> fn) Retrieves security privileges for the logged in user.getUserProfile
(GetUserProfileRequest request) Retrieves user profiles for the given unique ID(s).final GetUserProfileResponse
Retrieves user profiles for the given unique ID(s).grantApiKey
(GrantApiKeyRequest request) Creates an API key on behalf of another user.final GrantApiKeyResponse
Creates an API key on behalf of another user.Determines whether the specified user has a specified list of privileges.hasPrivileges
(HasPrivilegesRequest request) Determines whether the specified user has a specified list of privileges.final HasPrivilegesResponse
Determines whether the specified user has a specified list of privileges.Determines whether the users associated with the specified profile IDs have all the requested privileges.hasPrivilegesUserProfile
(Function<HasPrivilegesUserProfileRequest.Builder, ObjectBuilder<HasPrivilegesUserProfileRequest>> fn) Determines whether the users associated with the specified profile IDs have all the requested privileges.Invalidates one or more API keys.invalidateApiKey
(InvalidateApiKeyRequest request) Invalidates one or more API keys.final InvalidateApiKeyResponse
invalidateApiKey
(Function<InvalidateApiKeyRequest.Builder, ObjectBuilder<InvalidateApiKeyRequest>> fn) Invalidates one or more API keys.Invalidates one or more access tokens or refresh tokens.invalidateToken
(InvalidateTokenRequest request) Invalidates one or more access tokens or refresh tokens.final InvalidateTokenResponse
Invalidates one or more access tokens or refresh tokens.Adds or updates application privileges.putPrivileges
(PutPrivilegesRequest request) Adds or updates application privileges.final PutPrivilegesResponse
Adds or updates application privileges.putRole
(PutRoleRequest request) Adds and updates roles in the native realm.final PutRoleResponse
Adds and updates roles in the native realm.putRoleMapping
(PutRoleMappingRequest request) Creates and updates role mappings.final PutRoleMappingResponse
Creates and updates role mappings.putUser
(PutUserRequest request) Adds and updates users in the native realm.final PutUserResponse
Adds and updates users in the native realm.Retrieves information for API keys using a subset of query DSLqueryApiKeys
(QueryApiKeysRequest request) Retrieves information for API keys using a subset of query DSLfinal QueryApiKeysResponse
Retrieves information for API keys using a subset of query DSLsamlAuthenticate
(SamlAuthenticateRequest request) Exchanges a SAML Response message for an Elasticsearch access token and refresh token pairfinal SamlAuthenticateResponse
samlAuthenticate
(Function<SamlAuthenticateRequest.Builder, ObjectBuilder<SamlAuthenticateRequest>> fn) Exchanges a SAML Response message for an Elasticsearch access token and refresh token pairVerifies the logout response sent from the SAML IdPfinal BooleanResponse
samlCompleteLogout
(Function<SamlCompleteLogoutRequest.Builder, ObjectBuilder<SamlCompleteLogoutRequest>> fn) Verifies the logout response sent from the SAML IdPsamlInvalidate
(SamlInvalidateRequest request) Consumes a SAML LogoutRequestfinal SamlInvalidateResponse
Consumes a SAML LogoutRequestsamlLogout
(SamlLogoutRequest request) Invalidates an access token and a refresh token that were generated via the SAML Authenticate APIfinal SamlLogoutResponse
Invalidates an access token and a refresh token that were generated via the SAML Authenticate APICreates a SAML authentication requestCreates a SAML authentication requestsamlPrepareAuthentication
(Function<SamlPrepareAuthenticationRequest.Builder, ObjectBuilder<SamlPrepareAuthenticationRequest>> fn) Creates a SAML authentication requestGenerates SAML metadata for the Elastic stack SAML 2.0 Service ProvidersamlServiceProviderMetadata
(Function<SamlServiceProviderMetadataRequest.Builder, ObjectBuilder<SamlServiceProviderMetadataRequest>> fn) Generates SAML metadata for the Elastic stack SAML 2.0 Service ProviderGet suggestions for user profiles that match specified search criteria.Get suggestions for user profiles that match specified search criteria.suggestUserProfiles
(Function<SuggestUserProfilesRequest.Builder, ObjectBuilder<SuggestUserProfilesRequest>> fn) Get suggestions for user profiles that match specified search criteria.updateApiKey
(UpdateApiKeyRequest request) Updates attributes of an existing API key.final UpdateApiKeyResponse
Updates attributes of an existing API key.Update application specific data for the user profile of the given unique ID.updateUserProfileData
(Function<UpdateUserProfileDataRequest.Builder, ObjectBuilder<UpdateUserProfileDataRequest>> fn) Update application specific data for the user profile of the given unique ID.withTransportOptions
(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions
-
Constructor Details
-
ElasticsearchSecurityClient
-
ElasticsearchSecurityClient
public ElasticsearchSecurityClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
public ElasticsearchSecurityClient withTransportOptions(@Nullable TransportOptions transportOptions) Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,
ElasticsearchSecurityClient>
-
activateUserProfile
public ActivateUserProfileResponse activateUserProfile(ActivateUserProfileRequest request) throws IOException, ElasticsearchException Creates or updates the user profile on behalf of another user.- Throws:
IOException
ElasticsearchException
- See Also:
-
activateUserProfile
public final ActivateUserProfileResponse activateUserProfile(Function<ActivateUserProfileRequest.Builder, ObjectBuilder<ActivateUserProfileRequest>> fn) throws IOException, ElasticsearchExceptionCreates or updates the user profile on behalf of another user.- Parameters:
fn
- a function that initializes a builder to create theActivateUserProfileRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
authenticate
Enables authentication as a user and retrieve information about the authenticated user.- Throws:
IOException
ElasticsearchException
- See Also:
-
changePassword
public ChangePasswordResponse changePassword(ChangePasswordRequest request) throws IOException, ElasticsearchException Changes the passwords of users in the native realm and built-in users.- Throws:
IOException
ElasticsearchException
- See Also:
-
changePassword
public final ChangePasswordResponse changePassword(Function<ChangePasswordRequest.Builder, ObjectBuilder<ChangePasswordRequest>> fn) throws IOException, ElasticsearchExceptionChanges the passwords of users in the native realm and built-in users.- Parameters:
fn
- a function that initializes a builder to create theChangePasswordRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
changePassword
Changes the passwords of users in the native realm and built-in users.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearApiKeyCache
public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request) throws IOException, ElasticsearchException Clear a subset or all entries from the API key cache.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearApiKeyCache
public final ClearApiKeyCacheResponse clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder, ObjectBuilder<ClearApiKeyCacheRequest>> fn) throws IOException, ElasticsearchExceptionClear a subset or all entries from the API key cache.- Parameters:
fn
- a function that initializes a builder to create theClearApiKeyCacheRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedPrivileges
public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivilegesRequest request) throws IOException, ElasticsearchException Evicts application privileges from the native application privileges cache.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedPrivileges
public final ClearCachedPrivilegesResponse clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder, ObjectBuilder<ClearCachedPrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionEvicts application privileges from the native application privileges cache.- Parameters:
fn
- a function that initializes a builder to create theClearCachedPrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedRealms
public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest request) throws IOException, ElasticsearchException Evicts users from the user cache. Can completely clear the cache or evict specific users.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedRealms
public final ClearCachedRealmsResponse clearCachedRealms(Function<ClearCachedRealmsRequest.Builder, ObjectBuilder<ClearCachedRealmsRequest>> fn) throws IOException, ElasticsearchExceptionEvicts users from the user cache. Can completely clear the cache or evict specific users.- Parameters:
fn
- a function that initializes a builder to create theClearCachedRealmsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedRoles
public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request) throws IOException, ElasticsearchException Evicts roles from the native role cache.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedRoles
public final ClearCachedRolesResponse clearCachedRoles(Function<ClearCachedRolesRequest.Builder, ObjectBuilder<ClearCachedRolesRequest>> fn) throws IOException, ElasticsearchExceptionEvicts roles from the native role cache.- Parameters:
fn
- a function that initializes a builder to create theClearCachedRolesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedServiceTokens
public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServiceTokensRequest request) throws IOException, ElasticsearchException Evicts tokens from the service account token caches.- Throws:
IOException
ElasticsearchException
- See Also:
-
clearCachedServiceTokens
public final ClearCachedServiceTokensResponse clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder, ObjectBuilder<ClearCachedServiceTokensRequest>> fn) throws IOException, ElasticsearchExceptionEvicts tokens from the service account token caches.- Parameters:
fn
- a function that initializes a builder to create theClearCachedServiceTokensRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
createApiKey
public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request) throws IOException, ElasticsearchException Creates an API key for access without requiring basic authentication.- Throws:
IOException
ElasticsearchException
- See Also:
-
createApiKey
public final CreateApiKeyResponse createApiKey(Function<CreateApiKeyRequest.Builder, ObjectBuilder<CreateApiKeyRequest>> fn) throws IOException, ElasticsearchExceptionCreates an API key for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theCreateApiKeyRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
createApiKey
Creates an API key for access without requiring basic authentication.- Throws:
IOException
ElasticsearchException
- See Also:
-
createServiceToken
public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest request) throws IOException, ElasticsearchException Creates a service account token for access without requiring basic authentication.- Throws:
IOException
ElasticsearchException
- See Also:
-
createServiceToken
public final CreateServiceTokenResponse createServiceToken(Function<CreateServiceTokenRequest.Builder, ObjectBuilder<CreateServiceTokenRequest>> fn) throws IOException, ElasticsearchExceptionCreates a service account token for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theCreateServiceTokenRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
deletePrivileges
public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request) throws IOException, ElasticsearchException Removes application privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
deletePrivileges
public final DeletePrivilegesResponse deletePrivileges(Function<DeletePrivilegesRequest.Builder, ObjectBuilder<DeletePrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionRemoves application privileges.- Parameters:
fn
- a function that initializes a builder to create theDeletePrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteRole
public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws IOException, ElasticsearchException Removes roles in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteRole
public final DeleteRoleResponse deleteRole(Function<DeleteRoleRequest.Builder, ObjectBuilder<DeleteRoleRequest>> fn) throws IOException, ElasticsearchExceptionRemoves roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create theDeleteRoleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteRoleMapping
public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request) throws IOException, ElasticsearchException Removes role mappings.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteRoleMapping
public final DeleteRoleMappingResponse deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder, ObjectBuilder<DeleteRoleMappingRequest>> fn) throws IOException, ElasticsearchExceptionRemoves role mappings.- Parameters:
fn
- a function that initializes a builder to create theDeleteRoleMappingRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteServiceToken
public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest request) throws IOException, ElasticsearchException Deletes a service account token.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteServiceToken
public final DeleteServiceTokenResponse deleteServiceToken(Function<DeleteServiceTokenRequest.Builder, ObjectBuilder<DeleteServiceTokenRequest>> fn) throws IOException, ElasticsearchExceptionDeletes a service account token.- Parameters:
fn
- a function that initializes a builder to create theDeleteServiceTokenRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteUser
public DeleteUserResponse deleteUser(DeleteUserRequest request) throws IOException, ElasticsearchException Deletes users from the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
deleteUser
public final DeleteUserResponse deleteUser(Function<DeleteUserRequest.Builder, ObjectBuilder<DeleteUserRequest>> fn) throws IOException, ElasticsearchExceptionDeletes users from the native realm.- Parameters:
fn
- a function that initializes a builder to create theDeleteUserRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
disableUser
public DisableUserResponse disableUser(DisableUserRequest request) throws IOException, ElasticsearchException Disables users in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
disableUser
public final DisableUserResponse disableUser(Function<DisableUserRequest.Builder, ObjectBuilder<DisableUserRequest>> fn) throws IOException, ElasticsearchExceptionDisables users in the native realm.- Parameters:
fn
- a function that initializes a builder to create theDisableUserRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
disableUserProfile
public DisableUserProfileResponse disableUserProfile(DisableUserProfileRequest request) throws IOException, ElasticsearchException Disables a user profile so it's not visible in user profile searches.- Throws:
IOException
ElasticsearchException
- See Also:
-
disableUserProfile
public final DisableUserProfileResponse disableUserProfile(Function<DisableUserProfileRequest.Builder, ObjectBuilder<DisableUserProfileRequest>> fn) throws IOException, ElasticsearchExceptionDisables a user profile so it's not visible in user profile searches.- Parameters:
fn
- a function that initializes a builder to create theDisableUserProfileRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
enableUser
public EnableUserResponse enableUser(EnableUserRequest request) throws IOException, ElasticsearchException Enables users in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
enableUser
public final EnableUserResponse enableUser(Function<EnableUserRequest.Builder, ObjectBuilder<EnableUserRequest>> fn) throws IOException, ElasticsearchExceptionEnables users in the native realm.- Parameters:
fn
- a function that initializes a builder to create theEnableUserRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
enableUserProfile
public EnableUserProfileResponse enableUserProfile(EnableUserProfileRequest request) throws IOException, ElasticsearchException Enables a user profile so it's visible in user profile searches.- Throws:
IOException
ElasticsearchException
- See Also:
-
enableUserProfile
public final EnableUserProfileResponse enableUserProfile(Function<EnableUserProfileRequest.Builder, ObjectBuilder<EnableUserProfileRequest>> fn) throws IOException, ElasticsearchExceptionEnables a user profile so it's visible in user profile searches.- Parameters:
fn
- a function that initializes a builder to create theEnableUserProfileRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
enrollKibana
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.- Throws:
IOException
ElasticsearchException
- See Also:
-
enrollNode
Allows a new node to enroll to an existing cluster with security enabled.- Throws:
IOException
ElasticsearchException
- See Also:
-
getApiKey
public GetApiKeyResponse getApiKey(GetApiKeyRequest request) throws IOException, ElasticsearchException Retrieves information for one or more API keys.- Throws:
IOException
ElasticsearchException
- See Also:
-
getApiKey
public final GetApiKeyResponse getApiKey(Function<GetApiKeyRequest.Builder, ObjectBuilder<GetApiKeyRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information for one or more API keys.- Parameters:
fn
- a function that initializes a builder to create theGetApiKeyRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getApiKey
Retrieves information for one or more API keys.- Throws:
IOException
ElasticsearchException
- See Also:
-
getBuiltinPrivileges
public GetBuiltinPrivilegesResponse getBuiltinPrivileges() throws IOException, ElasticsearchExceptionRetrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.- Throws:
IOException
ElasticsearchException
- See Also:
-
getPrivileges
public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request) throws IOException, ElasticsearchException Retrieves application privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
getPrivileges
public final GetPrivilegesResponse getPrivileges(Function<GetPrivilegesRequest.Builder, ObjectBuilder<GetPrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves application privileges.- Parameters:
fn
- a function that initializes a builder to create theGetPrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getPrivileges
Retrieves application privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
getRole
Retrieves roles in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
getRole
public final GetRoleResponse getRole(Function<GetRoleRequest.Builder, ObjectBuilder<GetRoleRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create theGetRoleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getRole
Retrieves roles in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
getRoleMapping
public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request) throws IOException, ElasticsearchException Retrieves role mappings.- Throws:
IOException
ElasticsearchException
- See Also:
-
getRoleMapping
public final GetRoleMappingResponse getRoleMapping(Function<GetRoleMappingRequest.Builder, ObjectBuilder<GetRoleMappingRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves role mappings.- Parameters:
fn
- a function that initializes a builder to create theGetRoleMappingRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getRoleMapping
Retrieves role mappings.- Throws:
IOException
ElasticsearchException
- See Also:
-
getServiceAccounts
public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest request) throws IOException, ElasticsearchException Retrieves information about service accounts.- Throws:
IOException
ElasticsearchException
- See Also:
-
getServiceAccounts
public final GetServiceAccountsResponse getServiceAccounts(Function<GetServiceAccountsRequest.Builder, ObjectBuilder<GetServiceAccountsRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information about service accounts.- Parameters:
fn
- a function that initializes a builder to create theGetServiceAccountsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getServiceAccounts
Retrieves information about service accounts.- Throws:
IOException
ElasticsearchException
- See Also:
-
getServiceCredentials
public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentialsRequest request) throws IOException, ElasticsearchException Retrieves information of all service credentials for a service account.- Throws:
IOException
ElasticsearchException
- See Also:
-
getServiceCredentials
public final GetServiceCredentialsResponse getServiceCredentials(Function<GetServiceCredentialsRequest.Builder, ObjectBuilder<GetServiceCredentialsRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information of all service credentials for a service account.- Parameters:
fn
- a function that initializes a builder to create theGetServiceCredentialsRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getToken
public GetTokenResponse getToken(GetTokenRequest request) throws IOException, ElasticsearchException Creates a bearer token for access without requiring basic authentication.- Throws:
IOException
ElasticsearchException
- See Also:
-
getToken
public final GetTokenResponse getToken(Function<GetTokenRequest.Builder, ObjectBuilder<GetTokenRequest>> fn) throws IOException, ElasticsearchExceptionCreates a bearer token for access without requiring basic authentication.- Parameters:
fn
- a function that initializes a builder to create theGetTokenRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getToken
Creates a bearer token for access without requiring basic authentication.- Throws:
IOException
ElasticsearchException
- See Also:
-
getUser
Retrieves information about users in the native realm and built-in users.- Throws:
IOException
ElasticsearchException
- See Also:
-
getUser
public final GetUserResponse getUser(Function<GetUserRequest.Builder, ObjectBuilder<GetUserRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information about users in the native realm and built-in users.- Parameters:
fn
- a function that initializes a builder to create theGetUserRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getUser
Retrieves information about users in the native realm and built-in users.- Throws:
IOException
ElasticsearchException
- See Also:
-
getUserPrivileges
public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest request) throws IOException, ElasticsearchException Retrieves security privileges for the logged in user.- Throws:
IOException
ElasticsearchException
- See Also:
-
getUserPrivileges
public final GetUserPrivilegesResponse getUserPrivileges(Function<GetUserPrivilegesRequest.Builder, ObjectBuilder<GetUserPrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves security privileges for the logged in user.- Parameters:
fn
- a function that initializes a builder to create theGetUserPrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
getUserPrivileges
Retrieves security privileges for the logged in user.- Throws:
IOException
ElasticsearchException
- See Also:
-
getUserProfile
public GetUserProfileResponse getUserProfile(GetUserProfileRequest request) throws IOException, ElasticsearchException Retrieves user profiles for the given unique ID(s).- Throws:
IOException
ElasticsearchException
- See Also:
-
getUserProfile
public final GetUserProfileResponse getUserProfile(Function<GetUserProfileRequest.Builder, ObjectBuilder<GetUserProfileRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves user profiles for the given unique ID(s).- Parameters:
fn
- a function that initializes a builder to create theGetUserProfileRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
grantApiKey
public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request) throws IOException, ElasticsearchException Creates an API key on behalf of another user.- Throws:
IOException
ElasticsearchException
- See Also:
-
grantApiKey
public final GrantApiKeyResponse grantApiKey(Function<GrantApiKeyRequest.Builder, ObjectBuilder<GrantApiKeyRequest>> fn) throws IOException, ElasticsearchExceptionCreates an API key on behalf of another user.- Parameters:
fn
- a function that initializes a builder to create theGrantApiKeyRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
hasPrivileges
public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request) throws IOException, ElasticsearchException Determines whether the specified user has a specified list of privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
hasPrivileges
public final HasPrivilegesResponse hasPrivileges(Function<HasPrivilegesRequest.Builder, ObjectBuilder<HasPrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionDetermines whether the specified user has a specified list of privileges.- Parameters:
fn
- a function that initializes a builder to create theHasPrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
hasPrivileges
Determines whether the specified user has a specified list of privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
hasPrivilegesUserProfile
public HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request) throws IOException, ElasticsearchException Determines whether the users associated with the specified profile IDs have all the requested privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
hasPrivilegesUserProfile
public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder, ObjectBuilder<HasPrivilegesUserProfileRequest>> fn) throws IOException, ElasticsearchExceptionDetermines whether the users associated with the specified profile IDs have all the requested privileges.- Parameters:
fn
- a function that initializes a builder to create theHasPrivilegesUserProfileRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateApiKey
public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request) throws IOException, ElasticsearchException Invalidates one or more API keys.- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateApiKey
public final InvalidateApiKeyResponse invalidateApiKey(Function<InvalidateApiKeyRequest.Builder, ObjectBuilder<InvalidateApiKeyRequest>> fn) throws IOException, ElasticsearchExceptionInvalidates one or more API keys.- Parameters:
fn
- a function that initializes a builder to create theInvalidateApiKeyRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateApiKey
Invalidates one or more API keys.- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateToken
public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request) throws IOException, ElasticsearchException Invalidates one or more access tokens or refresh tokens.- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateToken
public final InvalidateTokenResponse invalidateToken(Function<InvalidateTokenRequest.Builder, ObjectBuilder<InvalidateTokenRequest>> fn) throws IOException, ElasticsearchExceptionInvalidates one or more access tokens or refresh tokens.- Parameters:
fn
- a function that initializes a builder to create theInvalidateTokenRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
invalidateToken
Invalidates one or more access tokens or refresh tokens.- Throws:
IOException
ElasticsearchException
- See Also:
-
putPrivileges
public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request) throws IOException, ElasticsearchException Adds or updates application privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
putPrivileges
public final PutPrivilegesResponse putPrivileges(Function<PutPrivilegesRequest.Builder, ObjectBuilder<PutPrivilegesRequest>> fn) throws IOException, ElasticsearchExceptionAdds or updates application privileges.- Parameters:
fn
- a function that initializes a builder to create thePutPrivilegesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
putPrivileges
Adds or updates application privileges.- Throws:
IOException
ElasticsearchException
- See Also:
-
putRole
Adds and updates roles in the native realm.- Throws:
IOException
ElasticsearchException
- See Also:
-
putRole
public final PutRoleResponse putRole(Function<PutRoleRequest.Builder, ObjectBuilder<PutRoleRequest>> fn) throws IOException, ElasticsearchExceptionAdds and updates roles in the native realm.- Parameters:
fn
- a function that initializes a builder to create thePutRoleRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
putRoleMapping
public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request) throws IOException, ElasticsearchException Creates and updates role mappings.- Throws:
IOException
ElasticsearchException
- See Also:
-
putRoleMapping
public final PutRoleMappingResponse putRoleMapping(Function<PutRoleMappingRequest.Builder, ObjectBuilder<PutRoleMappingRequest>> fn) throws IOException, ElasticsearchExceptionCreates and updates role mappings.- Parameters:
fn
- a function that initializes a builder to create thePutRoleMappingRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
putUser
Adds and updates users in the native realm. These users are commonly referred to as native users.- Throws:
IOException
ElasticsearchException
- See Also:
-
putUser
public final PutUserResponse putUser(Function<PutUserRequest.Builder, ObjectBuilder<PutUserRequest>> fn) throws IOException, ElasticsearchExceptionAdds and updates users in the native realm. These users are commonly referred to as native users.- Parameters:
fn
- a function that initializes a builder to create thePutUserRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
queryApiKeys
public QueryApiKeysResponse queryApiKeys(QueryApiKeysRequest request) throws IOException, ElasticsearchException Retrieves information for API keys using a subset of query DSL- Throws:
IOException
ElasticsearchException
- See Also:
-
queryApiKeys
public final QueryApiKeysResponse queryApiKeys(Function<QueryApiKeysRequest.Builder, ObjectBuilder<QueryApiKeysRequest>> fn) throws IOException, ElasticsearchExceptionRetrieves information for API keys using a subset of query DSL- Parameters:
fn
- a function that initializes a builder to create theQueryApiKeysRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
queryApiKeys
Retrieves information for API keys using a subset of query DSL- Throws:
IOException
ElasticsearchException
- See Also:
-
samlAuthenticate
public SamlAuthenticateResponse samlAuthenticate(SamlAuthenticateRequest request) throws IOException, ElasticsearchException Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair- Throws:
IOException
ElasticsearchException
- See Also:
-
samlAuthenticate
public final SamlAuthenticateResponse samlAuthenticate(Function<SamlAuthenticateRequest.Builder, ObjectBuilder<SamlAuthenticateRequest>> fn) throws IOException, ElasticsearchExceptionExchanges a SAML Response message for an Elasticsearch access token and refresh token pair- Parameters:
fn
- a function that initializes a builder to create theSamlAuthenticateRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
samlCompleteLogout
public BooleanResponse samlCompleteLogout(SamlCompleteLogoutRequest request) throws IOException, ElasticsearchException Verifies the logout response sent from the SAML IdP- Throws:
IOException
ElasticsearchException
- See Also:
-
samlCompleteLogout
public final BooleanResponse samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder, ObjectBuilder<SamlCompleteLogoutRequest>> fn) throws IOException, ElasticsearchExceptionVerifies the logout response sent from the SAML IdP- Parameters:
fn
- a function that initializes a builder to create theSamlCompleteLogoutRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
samlInvalidate
public SamlInvalidateResponse samlInvalidate(SamlInvalidateRequest request) throws IOException, ElasticsearchException Consumes a SAML LogoutRequest- Throws:
IOException
ElasticsearchException
- See Also:
-
samlInvalidate
public final SamlInvalidateResponse samlInvalidate(Function<SamlInvalidateRequest.Builder, ObjectBuilder<SamlInvalidateRequest>> fn) throws IOException, ElasticsearchExceptionConsumes a SAML LogoutRequest- Parameters:
fn
- a function that initializes a builder to create theSamlInvalidateRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
samlLogout
public SamlLogoutResponse samlLogout(SamlLogoutRequest request) throws IOException, ElasticsearchException Invalidates an access token and a refresh token that were generated via the SAML Authenticate API- Throws:
IOException
ElasticsearchException
- See Also:
-
samlLogout
public final SamlLogoutResponse samlLogout(Function<SamlLogoutRequest.Builder, ObjectBuilder<SamlLogoutRequest>> fn) throws IOException, ElasticsearchExceptionInvalidates an access token and a refresh token that were generated via the SAML Authenticate API- Parameters:
fn
- a function that initializes a builder to create theSamlLogoutRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
samlPrepareAuthentication
public SamlPrepareAuthenticationResponse samlPrepareAuthentication(SamlPrepareAuthenticationRequest request) throws IOException, ElasticsearchException Creates a SAML authentication request- Throws:
IOException
ElasticsearchException
- See Also:
-
samlPrepareAuthentication
public final SamlPrepareAuthenticationResponse samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder, ObjectBuilder<SamlPrepareAuthenticationRequest>> fn) throws IOException, ElasticsearchExceptionCreates a SAML authentication request- Parameters:
fn
- a function that initializes a builder to create theSamlPrepareAuthenticationRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
samlPrepareAuthentication
public SamlPrepareAuthenticationResponse samlPrepareAuthentication() throws IOException, ElasticsearchExceptionCreates a SAML authentication request- Throws:
IOException
ElasticsearchException
- See Also:
-
samlServiceProviderMetadata
public SamlServiceProviderMetadataResponse samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request) throws IOException, ElasticsearchException Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider- Throws:
IOException
ElasticsearchException
- See Also:
-
samlServiceProviderMetadata
public final SamlServiceProviderMetadataResponse samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder, ObjectBuilder<SamlServiceProviderMetadataRequest>> fn) throws IOException, ElasticsearchExceptionGenerates SAML metadata for the Elastic stack SAML 2.0 Service Provider- Parameters:
fn
- a function that initializes a builder to create theSamlServiceProviderMetadataRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
suggestUserProfiles
public SuggestUserProfilesResponse suggestUserProfiles(SuggestUserProfilesRequest request) throws IOException, ElasticsearchException Get suggestions for user profiles that match specified search criteria.- Throws:
IOException
ElasticsearchException
- See Also:
-
suggestUserProfiles
public final SuggestUserProfilesResponse suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder, ObjectBuilder<SuggestUserProfilesRequest>> fn) throws IOException, ElasticsearchExceptionGet suggestions for user profiles that match specified search criteria.- Parameters:
fn
- a function that initializes a builder to create theSuggestUserProfilesRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
suggestUserProfiles
Get suggestions for user profiles that match specified search criteria.- Throws:
IOException
ElasticsearchException
- See Also:
-
updateApiKey
public UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest request) throws IOException, ElasticsearchException Updates attributes of an existing API key.- Throws:
IOException
ElasticsearchException
- See Also:
-
updateApiKey
public final UpdateApiKeyResponse updateApiKey(Function<UpdateApiKeyRequest.Builder, ObjectBuilder<UpdateApiKeyRequest>> fn) throws IOException, ElasticsearchExceptionUpdates attributes of an existing API key.- Parameters:
fn
- a function that initializes a builder to create theUpdateApiKeyRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-
updateUserProfileData
public UpdateUserProfileDataResponse updateUserProfileData(UpdateUserProfileDataRequest request) throws IOException, ElasticsearchException Update application specific data for the user profile of the given unique ID.- Throws:
IOException
ElasticsearchException
- See Also:
-
updateUserProfileData
public final UpdateUserProfileDataResponse updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder, ObjectBuilder<UpdateUserProfileDataRequest>> fn) throws IOException, ElasticsearchExceptionUpdate application specific data for the user profile of the given unique ID.- Parameters:
fn
- a function that initializes a builder to create theUpdateUserProfileDataRequest
- Throws:
IOException
ElasticsearchException
- See Also:
-