java.lang.Object

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

co.elastic.clients.elasticsearch.security.ElasticsearchSecurityClient

All Implemented Interfaces:: Closeable, AutoCloseable

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

Constructors

Constructor

Description

ElasticsearchSecurityClient(ElasticsearchTransport transport)

ElasticsearchSecurityClient(ElasticsearchTransport transport, TransportOptions transportOptions)
Method Summary

Modifier and Type

Method

Description

ActivateUserProfileResponse

activateUserProfile(ActivateUserProfileRequest request)

Activate a user profile.

final ActivateUserProfileResponse

activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)

Activate a user profile.

AuthenticateResponse

authenticate()

Authenticate a user.

BulkDeleteRoleResponse

bulkDeleteRole(BulkDeleteRoleRequest request)

Bulk delete roles.

final BulkDeleteRoleResponse

bulkDeleteRole(Function<BulkDeleteRoleRequest.Builder,ObjectBuilder<BulkDeleteRoleRequest>> fn)

Bulk delete roles.

BulkPutRoleResponse

bulkPutRole(BulkPutRoleRequest request)

Bulk create or update roles.

final BulkPutRoleResponse

bulkPutRole(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn)

Bulk create or update roles.

ChangePasswordResponse

changePassword()

Change passwords.

ChangePasswordResponse

changePassword(ChangePasswordRequest request)

Change passwords.

final ChangePasswordResponse

changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)

Change passwords.

ClearApiKeyCacheResponse

clearApiKeyCache(ClearApiKeyCacheRequest request)

Clear the API key cache.

final ClearApiKeyCacheResponse

clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn)

Clear the API key cache.

ClearCachedPrivilegesResponse

clearCachedPrivileges(ClearCachedPrivilegesRequest request)

Clear the privileges cache.

final ClearCachedPrivilegesResponse

clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn)

Clear the privileges cache.

ClearCachedRealmsResponse

clearCachedRealms(ClearCachedRealmsRequest request)

Clear the user cache.

final ClearCachedRealmsResponse

clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn)

Clear the user cache.

ClearCachedRolesResponse

clearCachedRoles(ClearCachedRolesRequest request)

Clear the roles cache.

final ClearCachedRolesResponse

clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn)

Clear the roles cache.

ClearCachedServiceTokensResponse

clearCachedServiceTokens(ClearCachedServiceTokensRequest request)

Clear service account token caches.

final ClearCachedServiceTokensResponse

clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn)

Clear service account token caches.

CreateApiKeyResponse

createApiKey()

Create an API key.

CreateApiKeyResponse

createApiKey(CreateApiKeyRequest request)

Create an API key.

final CreateApiKeyResponse

createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn)

Create an API key.

CreateCrossClusterApiKeyResponse

createCrossClusterApiKey(CreateCrossClusterApiKeyRequest request)

Create a cross-cluster API key.

final CreateCrossClusterApiKeyResponse

createCrossClusterApiKey(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> fn)

Create a cross-cluster API key.

CreateServiceTokenResponse

createServiceToken(CreateServiceTokenRequest request)

Create a service account token.

final CreateServiceTokenResponse

createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn)

Create a service account token.

DeletePrivilegesResponse

deletePrivileges(DeletePrivilegesRequest request)

Delete application privileges.

final DeletePrivilegesResponse

deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn)

Delete application privileges.

DeleteRoleResponse

deleteRole(DeleteRoleRequest request)

Delete roles.

final DeleteRoleResponse

deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)

Delete roles.

DeleteRoleMappingResponse

deleteRoleMapping(DeleteRoleMappingRequest request)

Delete role mappings.

final DeleteRoleMappingResponse

deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)

Delete role mappings.

DeleteServiceTokenResponse

deleteServiceToken(DeleteServiceTokenRequest request)

Delete service account tokens.

final DeleteServiceTokenResponse

deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn)

Delete service account tokens.

DeleteUserResponse

deleteUser(DeleteUserRequest request)

Delete users.

final DeleteUserResponse

deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)

Delete users.

DisableUserResponse

disableUser(DisableUserRequest request)

Disable users.

final DisableUserResponse

disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn)

Disable users.

DisableUserProfileResponse

disableUserProfile(DisableUserProfileRequest request)

Disable a user profile.

final DisableUserProfileResponse

disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)

Disable a user profile.

EnableUserResponse

enableUser(EnableUserRequest request)

Enable users.

final EnableUserResponse

enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn)

Enable users.

EnableUserProfileResponse

enableUserProfile(EnableUserProfileRequest request)

Enable a user profile.

final EnableUserProfileResponse

enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn)

Enable a user profile.

EnrollKibanaResponse

enrollKibana()

Enroll Kibana.

EnrollNodeResponse

enrollNode()

Enroll a node.

GetApiKeyResponse

getApiKey()

Get API key information.

GetApiKeyResponse

getApiKey(GetApiKeyRequest request)

Get API key information.

final GetApiKeyResponse

getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn)

Get API key information.

GetBuiltinPrivilegesResponse

getBuiltinPrivileges()

Get builtin privileges.

GetPrivilegesResponse

getPrivileges()

Get application privileges.

GetPrivilegesResponse

getPrivileges(GetPrivilegesRequest request)

Get application privileges.

final GetPrivilegesResponse

getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn)

Get application privileges.

GetRoleResponse

getRole()

Get roles.

GetRoleResponse

getRole(GetRoleRequest request)

Get roles.

final GetRoleResponse

getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)

Get roles.

GetRoleMappingResponse

getRoleMapping()

Get role mappings.

GetRoleMappingResponse

getRoleMapping(GetRoleMappingRequest request)

Get role mappings.

final GetRoleMappingResponse

getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)

Get role mappings.

GetServiceAccountsResponse

getServiceAccounts()

Get service accounts.

GetServiceAccountsResponse

getServiceAccounts(GetServiceAccountsRequest request)

Get service accounts.

final GetServiceAccountsResponse

getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn)

Get service accounts.

GetServiceCredentialsResponse

getServiceCredentials(GetServiceCredentialsRequest request)

Get service account credentials.

final GetServiceCredentialsResponse

getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn)

Get service account credentials.

GetTokenResponse

getToken()

Get a token.

GetTokenResponse

getToken(GetTokenRequest request)

Get a token.

final GetTokenResponse

getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn)

Get a token.

GetUserResponse

getUser()

Get users.

GetUserResponse

getUser(GetUserRequest request)

Get users.

final GetUserResponse

getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)

Get users.

GetUserPrivilegesResponse

getUserPrivileges()

Get user privileges.

GetUserPrivilegesResponse

getUserPrivileges(GetUserPrivilegesRequest request)

Get user privileges.

final GetUserPrivilegesResponse

getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)

Get user privileges.

GetUserProfileResponse

getUserProfile(GetUserProfileRequest request)

Get a user profile.

final GetUserProfileResponse

getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn)

Get a user profile.

GrantApiKeyResponse

grantApiKey(GrantApiKeyRequest request)

Grant an API key.

final GrantApiKeyResponse

grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn)

Grant an API key.

HasPrivilegesResponse

hasPrivileges()

Check user privileges.

HasPrivilegesResponse

hasPrivileges(HasPrivilegesRequest request)

Check user privileges.

final HasPrivilegesResponse

hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn)

Check user privileges.

HasPrivilegesUserProfileResponse

hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request)

Check user profile privileges.

final HasPrivilegesUserProfileResponse

hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)

Check user profile privileges.

InvalidateApiKeyResponse

invalidateApiKey()

Invalidate API keys.

InvalidateApiKeyResponse

invalidateApiKey(InvalidateApiKeyRequest request)

Invalidate API keys.

final InvalidateApiKeyResponse

invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn)

Invalidate API keys.

InvalidateTokenResponse

invalidateToken()

Invalidate a token.

InvalidateTokenResponse

invalidateToken(InvalidateTokenRequest request)

Invalidate a token.

final InvalidateTokenResponse

invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)

Invalidate a token.

PutPrivilegesResponse

putPrivileges()

Create or update application privileges.

PutPrivilegesResponse

putPrivileges(PutPrivilegesRequest request)

Create or update application privileges.

final PutPrivilegesResponse

putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn)

Create or update application privileges.

PutRoleResponse

putRole(PutRoleRequest request)

Create or update roles.

final PutRoleResponse

putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn)

Create or update roles.

PutRoleMappingResponse

putRoleMapping(PutRoleMappingRequest request)

Create or update role mappings.

final PutRoleMappingResponse

putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn)

Create or update role mappings.

PutUserResponse

putUser(PutUserRequest request)

Create or update users.

final PutUserResponse

putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn)

Create or update users.

QueryApiKeysResponse

queryApiKeys()

Find API keys with a query.

QueryApiKeysResponse

queryApiKeys(QueryApiKeysRequest request)

Find API keys with a query.

final QueryApiKeysResponse

queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)

Find API keys with a query.

QueryRoleResponse

queryRole()

Find roles with a query.

QueryRoleResponse

queryRole(QueryRoleRequest request)

Find roles with a query.

final QueryRoleResponse

queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn)

Find roles with a query.

QueryUserResponse

queryUser()

Find users with a query.

QueryUserResponse

queryUser(QueryUserRequest request)

Find users with a query.

final QueryUserResponse

queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn)

Find users with a query.

SamlAuthenticateResponse

samlAuthenticate(SamlAuthenticateRequest request)

Authenticate SAML.

final SamlAuthenticateResponse

samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)

Authenticate SAML.

BooleanResponse

samlCompleteLogout(SamlCompleteLogoutRequest request)

Logout of SAML completely.

final BooleanResponse

samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)

Logout of SAML completely.

SamlInvalidateResponse

samlInvalidate(SamlInvalidateRequest request)

Invalidate SAML.

final SamlInvalidateResponse

samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn)

Invalidate SAML.

SamlLogoutResponse

samlLogout(SamlLogoutRequest request)

Logout of SAML.

final SamlLogoutResponse

samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)

Logout of SAML.

SamlPrepareAuthenticationResponse

samlPrepareAuthentication()

Prepare SAML authentication.

SamlPrepareAuthenticationResponse

samlPrepareAuthentication(SamlPrepareAuthenticationRequest request)

Prepare SAML authentication.

final SamlPrepareAuthenticationResponse

samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)

Prepare SAML authentication.

SamlServiceProviderMetadataResponse

samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request)

Create SAML service provider metadata.

final SamlServiceProviderMetadataResponse

samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)

Create SAML service provider metadata.

SuggestUserProfilesResponse

suggestUserProfiles()

Suggest a user profile.

SuggestUserProfilesResponse

suggestUserProfiles(SuggestUserProfilesRequest request)

Suggest a user profile.

final SuggestUserProfilesResponse

suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn)

Suggest a user profile.

UpdateApiKeyResponse

updateApiKey(UpdateApiKeyRequest request)

Update an API key.

final UpdateApiKeyResponse

updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn)

Update an API key.

UpdateCrossClusterApiKeyResponse

updateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request)

Update a cross-cluster API key.

final UpdateCrossClusterApiKeyResponse

updateCrossClusterApiKey(Function<UpdateCrossClusterApiKeyRequest.Builder,ObjectBuilder<UpdateCrossClusterApiKeyRequest>> fn)

Update a cross-cluster API key.

UpdateUserProfileDataResponse

updateUserProfileData(UpdateUserProfileDataRequest request)

Update user profile data.

final UpdateUserProfileDataResponse

updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn)

Update user profile data.

ElasticsearchSecurityClient

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
- ElasticsearchSecurityClient
  
  public ElasticsearchSecurityClient(ElasticsearchTransport transport)
- 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 class ApiClient<ElasticsearchTransport,ElasticsearchSecurityClient>
- activateUserProfile
  
  public ActivateUserProfileResponse activateUserProfile(ActivateUserProfileRequest request) throws IOException, ElasticsearchException
  
  Activate a user profile.
  Create or update a user profile on behalf of another user.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- activateUserProfile
  
  public final ActivateUserProfileResponse activateUserProfile(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- authenticate
  
  public AuthenticateResponse authenticate() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- bulkDeleteRole
  
  public BulkDeleteRoleResponse bulkDeleteRole(BulkDeleteRoleRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- bulkDeleteRole
  
  public final BulkDeleteRoleResponse bulkDeleteRole(Function<BulkDeleteRoleRequest.Builder,ObjectBuilder<BulkDeleteRoleRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- bulkPutRole
  
  public BulkPutRoleResponse bulkPutRole(BulkPutRoleRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- bulkPutRole
  
  public final BulkPutRoleResponse bulkPutRole(Function<BulkPutRoleRequest.Builder,ObjectBuilder<BulkPutRoleRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public ChangePasswordResponse changePassword(ChangePasswordRequest request) throws IOException, ElasticsearchException
  
  Change passwords.
  Change the passwords of users in the native realm and built-in users.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public final ChangePasswordResponse changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- changePassword
  
  public ChangePasswordResponse changePassword() throws IOException, ElasticsearchException
  
  Change passwords.
  Change the passwords of users in the native realm and built-in users.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearApiKeyCache
  
  public ClearApiKeyCacheResponse clearApiKeyCache(ClearApiKeyCacheRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearApiKeyCache
  
  public final ClearApiKeyCacheResponse clearApiKeyCache(Function<ClearApiKeyCacheRequest.Builder,ObjectBuilder<ClearApiKeyCacheRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedPrivileges
  
  public ClearCachedPrivilegesResponse clearCachedPrivileges(ClearCachedPrivilegesRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedPrivileges
  
  public final ClearCachedPrivilegesResponse clearCachedPrivileges(Function<ClearCachedPrivilegesRequest.Builder,ObjectBuilder<ClearCachedPrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRealms
  
  public ClearCachedRealmsResponse clearCachedRealms(ClearCachedRealmsRequest request) throws IOException, ElasticsearchException
  
  Clear the user cache.
  Evict users from the user cache. You can completely clear the cache or evict specific users.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRealms
  
  public final ClearCachedRealmsResponse clearCachedRealms(Function<ClearCachedRealmsRequest.Builder,ObjectBuilder<ClearCachedRealmsRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRoles
  
  public ClearCachedRolesResponse clearCachedRoles(ClearCachedRolesRequest request) throws IOException, ElasticsearchException
  
  Clear the roles cache.
  Evict roles from the native role cache.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedRoles
  
  public final ClearCachedRolesResponse clearCachedRoles(Function<ClearCachedRolesRequest.Builder,ObjectBuilder<ClearCachedRolesRequest>> fn) throws IOException, ElasticsearchException
  
  Clear the roles cache.
  Evict roles from the native role cache.
  Parameters:
  
  fn - a function that initializes a builder to create the ClearCachedRolesRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedServiceTokens
  
  public ClearCachedServiceTokensResponse clearCachedServiceTokens(ClearCachedServiceTokensRequest request) throws IOException, ElasticsearchException
  
  Clear service account token caches.
  Evict a subset of all entries from the service account token caches.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- clearCachedServiceTokens
  
  public final ClearCachedServiceTokensResponse clearCachedServiceTokens(Function<ClearCachedServiceTokensRequest.Builder,ObjectBuilder<ClearCachedServiceTokensRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public CreateApiKeyResponse createApiKey(CreateApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public final CreateApiKeyResponse createApiKey(Function<CreateApiKeyRequest.Builder,ObjectBuilder<CreateApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createApiKey
  
  public CreateApiKeyResponse createApiKey() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createCrossClusterApiKey
  
  public CreateCrossClusterApiKeyResponse createCrossClusterApiKey(CreateCrossClusterApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createCrossClusterApiKey
  
  public final CreateCrossClusterApiKeyResponse createCrossClusterApiKey(Function<CreateCrossClusterApiKeyRequest.Builder,ObjectBuilder<CreateCrossClusterApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createServiceToken
  
  public CreateServiceTokenResponse createServiceToken(CreateServiceTokenRequest request) throws IOException, ElasticsearchException
  
  Create a service account token.
  Create a service accounts token for access without requiring basic authentication.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- createServiceToken
  
  public final CreateServiceTokenResponse createServiceToken(Function<CreateServiceTokenRequest.Builder,ObjectBuilder<CreateServiceTokenRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deletePrivileges
  
  public DeletePrivilegesResponse deletePrivileges(DeletePrivilegesRequest request) throws IOException, ElasticsearchException
  
  Delete application privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deletePrivileges
  
  public final DeletePrivilegesResponse deletePrivileges(Function<DeletePrivilegesRequest.Builder,ObjectBuilder<DeletePrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  Delete application privileges.
  Parameters:
  
  fn - a function that initializes a builder to create the DeletePrivilegesRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRole
  
  public DeleteRoleResponse deleteRole(DeleteRoleRequest request) throws IOException, ElasticsearchException
  
  Delete roles.
  Delete roles in the native realm.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRole
  
  public final DeleteRoleResponse deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn) throws IOException, ElasticsearchException
  
  Delete roles.
  Delete roles in the native realm.
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteRoleRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRoleMapping
  
  public DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request) throws IOException, ElasticsearchException
  
  Delete role mappings.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteRoleMapping
  
  public final DeleteRoleMappingResponse deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn) throws IOException, ElasticsearchException
  
  Delete role mappings.
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteRoleMappingRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteServiceToken
  
  public DeleteServiceTokenResponse deleteServiceToken(DeleteServiceTokenRequest request) throws IOException, ElasticsearchException
  
  Delete service account tokens.
  Delete service account tokens for a service in a specified namespace.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteServiceToken
  
  public final DeleteServiceTokenResponse deleteServiceToken(Function<DeleteServiceTokenRequest.Builder,ObjectBuilder<DeleteServiceTokenRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteUser
  
  public DeleteUserResponse deleteUser(DeleteUserRequest request) throws IOException, ElasticsearchException
  
  Delete users.
  Delete users from the native realm.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- deleteUser
  
  public final DeleteUserResponse deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn) throws IOException, ElasticsearchException
  
  Delete users.
  Delete users from the native realm.
  Parameters:
  
  fn - a function that initializes a builder to create the DeleteUserRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUser
  
  public DisableUserResponse disableUser(DisableUserRequest request) throws IOException, ElasticsearchException
  
  Disable users.
  Disable users in the native realm.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUser
  
  public final DisableUserResponse disableUser(Function<DisableUserRequest.Builder,ObjectBuilder<DisableUserRequest>> fn) throws IOException, ElasticsearchException
  
  Disable users.
  Disable users in the native realm.
  Parameters:
  
  fn - a function that initializes a builder to create the DisableUserRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUserProfile
  
  public DisableUserProfileResponse disableUserProfile(DisableUserProfileRequest request) throws IOException, ElasticsearchException
  
  Disable a user profile.
  Disable user profiles so that they are not visible in user profile searches.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- disableUserProfile
  
  public final DisableUserProfileResponse disableUserProfile(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUser
  
  public EnableUserResponse enableUser(EnableUserRequest request) throws IOException, ElasticsearchException
  
  Enable users.
  Enable users in the native realm.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUser
  
  public final EnableUserResponse enableUser(Function<EnableUserRequest.Builder,ObjectBuilder<EnableUserRequest>> fn) throws IOException, ElasticsearchException
  
  Enable users.
  Enable users in the native realm.
  Parameters:
  
  fn - a function that initializes a builder to create the EnableUserRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUserProfile
  
  public EnableUserProfileResponse enableUserProfile(EnableUserProfileRequest request) throws IOException, ElasticsearchException
  
  Enable a user profile.
  Enable user profiles to make them visible in user profile searches.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enableUserProfile
  
  public final EnableUserProfileResponse enableUserProfile(Function<EnableUserProfileRequest.Builder,ObjectBuilder<EnableUserProfileRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enrollKibana
  
  public EnrollKibanaResponse enrollKibana() throws IOException, ElasticsearchException
  
  Enroll Kibana.
  Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- enrollNode
  
  public EnrollNodeResponse enrollNode() throws IOException, ElasticsearchException
  
  Enroll a node.
  Enroll a new node to allow it to join an existing cluster with security features enabled.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public GetApiKeyResponse getApiKey(GetApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public final GetApiKeyResponse getApiKey(Function<GetApiKeyRequest.Builder,ObjectBuilder<GetApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getApiKey
  
  public GetApiKeyResponse getApiKey() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getBuiltinPrivileges
  
  public GetBuiltinPrivilegesResponse getBuiltinPrivileges() throws IOException, ElasticsearchException
  
  Get builtin privileges.
  Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public GetPrivilegesResponse getPrivileges(GetPrivilegesRequest request) throws IOException, ElasticsearchException
  
  Get application privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public final GetPrivilegesResponse getPrivileges(Function<GetPrivilegesRequest.Builder,ObjectBuilder<GetPrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  Get application privileges.
  Parameters:
  
  fn - a function that initializes a builder to create the GetPrivilegesRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getPrivileges
  
  public GetPrivilegesResponse getPrivileges() throws IOException, ElasticsearchException
  
  Get application privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public GetRoleResponse getRole(GetRoleRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public final GetRoleResponse getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRole
  
  public GetRoleResponse getRole() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public final GetRoleMappingResponse getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getRoleMapping
  
  public GetRoleMappingResponse getRoleMapping() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public GetServiceAccountsResponse getServiceAccounts(GetServiceAccountsRequest request) throws IOException, ElasticsearchException
  
  Get service accounts.
  Get a list of service accounts that match the provided path parameters.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public final GetServiceAccountsResponse getServiceAccounts(Function<GetServiceAccountsRequest.Builder,ObjectBuilder<GetServiceAccountsRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceAccounts
  
  public GetServiceAccountsResponse getServiceAccounts() throws IOException, ElasticsearchException
  
  Get service accounts.
  Get a list of service accounts that match the provided path parameters.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceCredentials
  
  public GetServiceCredentialsResponse getServiceCredentials(GetServiceCredentialsRequest request) throws IOException, ElasticsearchException
  
  Get service account credentials.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getServiceCredentials
  
  public final GetServiceCredentialsResponse getServiceCredentials(Function<GetServiceCredentialsRequest.Builder,ObjectBuilder<GetServiceCredentialsRequest>> fn) throws IOException, ElasticsearchException
  
  Get service account credentials.
  Parameters:
  
  fn - a function that initializes a builder to create the GetServiceCredentialsRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public GetTokenResponse getToken(GetTokenRequest request) throws IOException, ElasticsearchException
  
  Get a token.
  Create a bearer token for access without requiring basic authentication.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public final GetTokenResponse getToken(Function<GetTokenRequest.Builder,ObjectBuilder<GetTokenRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getToken
  
  public GetTokenResponse getToken() throws IOException, ElasticsearchException
  
  Get a token.
  Create a bearer token for access without requiring basic authentication.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public GetUserResponse getUser(GetUserRequest request) throws IOException, ElasticsearchException
  
  Get users.
  Get information about users in the native realm and built-in users.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public final GetUserResponse getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUser
  
  public GetUserResponse getUser() throws IOException, ElasticsearchException
  
  Get users.
  Get information about users in the native realm and built-in users.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public GetUserPrivilegesResponse getUserPrivileges(GetUserPrivilegesRequest request) throws IOException, ElasticsearchException
  
  Get user privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public final GetUserPrivilegesResponse getUserPrivileges(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  Get user privileges.
  Parameters:
  
  fn - a function that initializes a builder to create the GetUserPrivilegesRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserPrivileges
  
  public GetUserPrivilegesResponse getUserPrivileges() throws IOException, ElasticsearchException
  
  Get user privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserProfile
  
  public GetUserProfileResponse getUserProfile(GetUserProfileRequest request) throws IOException, ElasticsearchException
  
  Get a user profile.
  Get a user's profile using the unique profile ID.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- getUserProfile
  
  public final GetUserProfileResponse getUserProfile(Function<GetUserProfileRequest.Builder,ObjectBuilder<GetUserProfileRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- grantApiKey
  
  public GrantApiKeyResponse grantApiKey(GrantApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- grantApiKey
  
  public final GrantApiKeyResponse grantApiKey(Function<GrantApiKeyRequest.Builder,ObjectBuilder<GrantApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public HasPrivilegesResponse hasPrivileges(HasPrivilegesRequest request) throws IOException, ElasticsearchException
  
  Check user privileges.
  Determine whether the specified user has a specified list of privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public final HasPrivilegesResponse hasPrivileges(Function<HasPrivilegesRequest.Builder,ObjectBuilder<HasPrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivileges
  
  public HasPrivilegesResponse hasPrivileges() throws IOException, ElasticsearchException
  
  Check user privileges.
  Determine whether the specified user has a specified list of privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivilegesUserProfile
  
  public HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(HasPrivilegesUserProfileRequest request) throws IOException, ElasticsearchException
  
  Check user profile privileges.
  Determine whether the users associated with the specified user profile IDs have all the requested privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- hasPrivilegesUserProfile
  
  public final HasPrivilegesUserProfileResponse hasPrivilegesUserProfile(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public InvalidateApiKeyResponse invalidateApiKey(InvalidateApiKeyRequest request) throws IOException, ElasticsearchException
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public final InvalidateApiKeyResponse invalidateApiKey(Function<InvalidateApiKeyRequest.Builder,ObjectBuilder<InvalidateApiKeyRequest>> fn) throws IOException, ElasticsearchException
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateApiKey
  
  public InvalidateApiKeyResponse invalidateApiKey() throws IOException, ElasticsearchException
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public InvalidateTokenResponse invalidateToken(InvalidateTokenRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public final InvalidateTokenResponse invalidateToken(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- invalidateToken
  
  public InvalidateTokenResponse invalidateToken() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public PutPrivilegesResponse putPrivileges(PutPrivilegesRequest request) throws IOException, ElasticsearchException
  
  Create or update application privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public final PutPrivilegesResponse putPrivileges(Function<PutPrivilegesRequest.Builder,ObjectBuilder<PutPrivilegesRequest>> fn) throws IOException, ElasticsearchException
  
  Create or update application privileges.
  Parameters:
  
  fn - a function that initializes a builder to create the PutPrivilegesRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putPrivileges
  
  public PutPrivilegesResponse putPrivileges() throws IOException, ElasticsearchException
  
  Create or update application privileges.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRole
  
  public PutRoleResponse putRole(PutRoleRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRole
  
  public final PutRoleResponse putRole(Function<PutRoleRequest.Builder,ObjectBuilder<PutRoleRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRoleMapping
  
  public PutRoleMappingResponse putRoleMapping(PutRoleMappingRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putRoleMapping
  
  public final PutRoleMappingResponse putRoleMapping(Function<PutRoleMappingRequest.Builder,ObjectBuilder<PutRoleMappingRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putUser
  
  public PutUserResponse putUser(PutUserRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- putUser
  
  public final PutUserResponse putUser(Function<PutUserRequest.Builder,ObjectBuilder<PutUserRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryApiKeys
  
  public QueryApiKeysResponse queryApiKeys(QueryApiKeysRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryApiKeys
  
  public final QueryApiKeysResponse queryApiKeys(Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryApiKeys
  
  public QueryApiKeysResponse queryApiKeys() throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryRole
  
  public QueryRoleResponse queryRole(QueryRoleRequest request) throws IOException, ElasticsearchException
  
  Find roles with a query.
  Get roles in a paginated manner. You can optionally filter the results with a query.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryRole
  
  public final QueryRoleResponse queryRole(Function<QueryRoleRequest.Builder,ObjectBuilder<QueryRoleRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryRole
  
  public QueryRoleResponse queryRole() throws IOException, ElasticsearchException
  
  Find roles with a query.
  Get roles in a paginated manner. You can optionally filter the results with a query.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryUser
  
  public QueryUserResponse queryUser(QueryUserRequest request) throws IOException, ElasticsearchException
  
  Find users with a query.
  Get information for users in a paginated manner. You can optionally filter the results with a query.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryUser
  
  public final QueryUserResponse queryUser(Function<QueryUserRequest.Builder,ObjectBuilder<QueryUserRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- queryUser
  
  public QueryUserResponse queryUser() throws IOException, ElasticsearchException
  
  Find users with a query.
  Get information for users in a paginated manner. You can optionally filter the results with a query.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlAuthenticate
  
  public SamlAuthenticateResponse samlAuthenticate(SamlAuthenticateRequest request) throws IOException, ElasticsearchException
  
  Authenticate SAML.
  Submits a SAML response message to Elasticsearch for consumption.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlAuthenticate
  
  public final SamlAuthenticateResponse samlAuthenticate(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn) throws IOException, ElasticsearchException
  
  Authenticate SAML.
  Submits a SAML response message to Elasticsearch for consumption.
  Parameters:
  
  fn - a function that initializes a builder to create the SamlAuthenticateRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlCompleteLogout
  
  public BooleanResponse samlCompleteLogout(SamlCompleteLogoutRequest request) throws IOException, ElasticsearchException
  
  Logout of SAML completely.
  Verifies the logout response sent from the SAML IdP.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlCompleteLogout
  
  public final BooleanResponse samlCompleteLogout(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlInvalidate
  
  public SamlInvalidateResponse samlInvalidate(SamlInvalidateRequest request) throws IOException, ElasticsearchException
  
  Invalidate SAML.
  Submits a SAML LogoutRequest message to Elasticsearch for consumption.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlInvalidate
  
  public final SamlInvalidateResponse samlInvalidate(Function<SamlInvalidateRequest.Builder,ObjectBuilder<SamlInvalidateRequest>> fn) throws IOException, ElasticsearchException
  
  Invalidate SAML.
  Submits a SAML LogoutRequest message to Elasticsearch for consumption.
  Parameters:
  
  fn - a function that initializes a builder to create the SamlInvalidateRequest
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlLogout
  
  public SamlLogoutResponse samlLogout(SamlLogoutRequest request) throws IOException, ElasticsearchException
  
  Logout of SAML.
  Submits a request to invalidate an access token and refresh token.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlLogout
  
  public final SamlLogoutResponse samlLogout(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlPrepareAuthentication
  
  public SamlPrepareAuthenticationResponse samlPrepareAuthentication(SamlPrepareAuthenticationRequest request) throws IOException, ElasticsearchException
  
  Prepare SAML authentication.
  Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlPrepareAuthentication
  
  public final SamlPrepareAuthenticationResponse samlPrepareAuthentication(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlPrepareAuthentication
  
  public SamlPrepareAuthenticationResponse samlPrepareAuthentication() throws IOException, ElasticsearchException
  
  Prepare SAML authentication.
  Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlServiceProviderMetadata
  
  public SamlServiceProviderMetadataResponse samlServiceProviderMetadata(SamlServiceProviderMetadataRequest request) throws IOException, ElasticsearchException
  
  Create SAML service provider metadata.
  Generate SAML metadata for a SAML 2.0 Service Provider.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- samlServiceProviderMetadata
  
  public final SamlServiceProviderMetadataResponse samlServiceProviderMetadata(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- suggestUserProfiles
  
  public SuggestUserProfilesResponse suggestUserProfiles(SuggestUserProfilesRequest request) throws IOException, ElasticsearchException
  
  Suggest a user profile.
  Get suggestions for user profiles that match specified search criteria.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- suggestUserProfiles
  
  public final SuggestUserProfilesResponse suggestUserProfiles(Function<SuggestUserProfilesRequest.Builder,ObjectBuilder<SuggestUserProfilesRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- suggestUserProfiles
  
  public SuggestUserProfilesResponse suggestUserProfiles() throws IOException, ElasticsearchException
  
  Suggest a user profile.
  Get suggestions for user profiles that match specified search criteria.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateApiKey
  
  public UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateApiKey
  
  public final UpdateApiKeyResponse updateApiKey(Function<UpdateApiKeyRequest.Builder,ObjectBuilder<UpdateApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateCrossClusterApiKey
  
  public UpdateCrossClusterApiKeyResponse updateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request) throws IOException, ElasticsearchException
  
  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.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateCrossClusterApiKey
  
  public final UpdateCrossClusterApiKeyResponse updateCrossClusterApiKey(Function<UpdateCrossClusterApiKeyRequest.Builder,ObjectBuilder<UpdateCrossClusterApiKeyRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateUserProfileData
  
  public UpdateUserProfileDataResponse updateUserProfileData(UpdateUserProfileDataRequest request) throws IOException, ElasticsearchException
  
  Update user profile data.
  Update specific data for the user profile that is associated with a unique ID.
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co
- updateUserProfileData
  
  public final UpdateUserProfileDataResponse updateUserProfileData(Function<UpdateUserProfileDataRequest.Builder,ObjectBuilder<UpdateUserProfileDataRequest>> fn) throws IOException, ElasticsearchException
  
  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
  
  Throws:
  
  IOException
  
  ElasticsearchException
  
  See Also:
  
  Documentation on elastic.co

Class ElasticsearchSecurityClient

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

Constructor Summary

Method Summary

Methods inherited from class co.elastic.clients.ApiClient

Methods inherited from class java.lang.Object

Constructor Details

ElasticsearchSecurityClient

ElasticsearchSecurityClient

Method Details

withTransportOptions

activateUserProfile

activateUserProfile

authenticate

bulkDeleteRole

bulkDeleteRole

bulkPutRole

bulkPutRole

changePassword

changePassword

changePassword

clearApiKeyCache

clearApiKeyCache

clearCachedPrivileges

clearCachedPrivileges

clearCachedRealms

clearCachedRealms

clearCachedRoles

clearCachedRoles

clearCachedServiceTokens

clearCachedServiceTokens

createApiKey

createApiKey

createApiKey

createCrossClusterApiKey

createCrossClusterApiKey

createServiceToken

createServiceToken

deletePrivileges

deletePrivileges

deleteRole

deleteRole

deleteRoleMapping

deleteRoleMapping

deleteServiceToken

deleteServiceToken

deleteUser

deleteUser

disableUser

disableUser

disableUserProfile

disableUserProfile

enableUser

enableUser

enableUserProfile

enableUserProfile

enrollKibana

enrollNode

getApiKey

getApiKey

getApiKey

getBuiltinPrivileges

getPrivileges

getPrivileges

getPrivileges

getRole

getRole

getRole

getRoleMapping

getRoleMapping

getRoleMapping

getServiceAccounts

getServiceAccounts

getServiceAccounts

getServiceCredentials

getServiceCredentials

getToken

getToken

getToken