Package org.opensearch.client.opensearch.security

Class OpenSearchSecurityAsyncClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchSecurityAsyncClient>

org.opensearch.client.opensearch.security.OpenSearchSecurityAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchSecurityAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchSecurityAsyncClient>

Client for the security namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchSecurityAsyncClient(OpenSearchTransport transport)
OpenSearchSecurityAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<AuthinfoResponse>	authinfo()	Returns or updates authentication information for the currently authenticated user.
final CompletableFuture<AuthinfoResponse>	authinfo(Function<AuthinfoRequest.Builder,ObjectBuilder<AuthinfoRequest>> fn)	Returns or updates authentication information for the currently authenticated user.
CompletableFuture<AuthinfoResponse>	authinfo(AuthinfoRequest request)	Returns or updates authentication information for the currently authenticated user.
final CompletableFuture<AuthtokenResponse>	authtoken()	Returns the authorization token for the current user.
final CompletableFuture<AuthtokenResponse>	authtoken(Function<AuthtokenRequest.Builder,ObjectBuilder<AuthtokenRequest>> fn)	Returns the authorization token for the current user.
CompletableFuture<AuthtokenResponse>	authtoken(AuthtokenRequest request)	Returns the authorization token for the current user.
final CompletableFuture<ChangePasswordResponse>	changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)	Changes the password for the current user.
CompletableFuture<ChangePasswordResponse>	changePassword(ChangePasswordRequest request)	Changes the password for the current user.
final CompletableFuture<ConfigUpgradeCheckResponse>	configUpgradeCheck()	Checks whether or not an upgrade can be performed and which security resources can be updated.
final CompletableFuture<ConfigUpgradeCheckResponse>	configUpgradeCheck(Function<ConfigUpgradeCheckRequest.Builder,ObjectBuilder<ConfigUpgradeCheckRequest>> fn)	Checks whether or not an upgrade can be performed and which security resources can be updated.
CompletableFuture<ConfigUpgradeCheckResponse>	configUpgradeCheck(ConfigUpgradeCheckRequest request)	Checks whether or not an upgrade can be performed and which security resources can be updated.
final CompletableFuture<ConfigUpgradePerformResponse>	configUpgradePerform()	Assists the cluster operator with upgrading missing default values and stale default definitions.
final CompletableFuture<ConfigUpgradePerformResponse>	configUpgradePerform(Function<ConfigUpgradePerformRequest.Builder,ObjectBuilder<ConfigUpgradePerformRequest>> fn)	Assists the cluster operator with upgrading missing default values and stale default definitions.
CompletableFuture<ConfigUpgradePerformResponse>	configUpgradePerform(ConfigUpgradePerformRequest request)	Assists the cluster operator with upgrading missing default values and stale default definitions.
final CompletableFuture<CreateActionGroupResponse>	createActionGroup(Function<CreateActionGroupRequest.Builder,ObjectBuilder<CreateActionGroupRequest>> fn)	Creates or replaces the specified action group.
CompletableFuture<CreateActionGroupResponse>	createActionGroup(CreateActionGroupRequest request)	Creates or replaces the specified action group.
final CompletableFuture<CreateAllowlistResponse>	createAllowlist()	Creates or replaces APIs permitted for users on the allow list.
final CompletableFuture<CreateAllowlistResponse>	createAllowlist(Function<CreateAllowlistRequest.Builder,ObjectBuilder<CreateAllowlistRequest>> fn)	Creates or replaces APIs permitted for users on the allow list.
CompletableFuture<CreateAllowlistResponse>	createAllowlist(CreateAllowlistRequest request)	Creates or replaces APIs permitted for users on the allow list.
final CompletableFuture<CreateRoleResponse>	createRole(Function<CreateRoleRequest.Builder,ObjectBuilder<CreateRoleRequest>> fn)	Creates or replaces the specified role.
CompletableFuture<CreateRoleResponse>	createRole(CreateRoleRequest request)	Creates or replaces the specified role.
final CompletableFuture<CreateRoleMappingResponse>	createRoleMapping(Function<CreateRoleMappingRequest.Builder,ObjectBuilder<CreateRoleMappingRequest>> fn)	Creates or replaces the specified role mapping.
CompletableFuture<CreateRoleMappingResponse>	createRoleMapping(CreateRoleMappingRequest request)	Creates or replaces the specified role mapping.
final CompletableFuture<CreateTenantResponse>	createTenant(Function<CreateTenantRequest.Builder,ObjectBuilder<CreateTenantRequest>> fn)	Creates or replaces the specified tenant.
CompletableFuture<CreateTenantResponse>	createTenant(CreateTenantRequest request)	Creates or replaces the specified tenant.
final CompletableFuture<CreateUpdateTenancyConfigResponse>	createUpdateTenancyConfig()	Creates or replaces the multi-tenancy configuration.
final CompletableFuture<CreateUpdateTenancyConfigResponse>	createUpdateTenancyConfig(Function<CreateUpdateTenancyConfigRequest.Builder,ObjectBuilder<CreateUpdateTenancyConfigRequest>> fn)	Creates or replaces the multi-tenancy configuration.
CompletableFuture<CreateUpdateTenancyConfigResponse>	createUpdateTenancyConfig(CreateUpdateTenancyConfigRequest request)	Creates or replaces the multi-tenancy configuration.
final CompletableFuture<CreateUserResponse>	createUser(Function<CreateUserRequest.Builder,ObjectBuilder<CreateUserRequest>> fn)	Creates or replaces the specified user.
CompletableFuture<CreateUserResponse>	createUser(CreateUserRequest request)	Creates or replaces the specified user.
final CompletableFuture<CreateUserLegacyResponse>	createUserLegacy(Function<CreateUserLegacyRequest.Builder,ObjectBuilder<CreateUserLegacyRequest>> fn)	Creates or replaces the specified user.
CompletableFuture<CreateUserLegacyResponse>	createUserLegacy(CreateUserLegacyRequest request)	Creates or replaces the specified user.
final CompletableFuture<DeleteActionGroupResponse>	deleteActionGroup(Function<DeleteActionGroupRequest.Builder,ObjectBuilder<DeleteActionGroupRequest>> fn)	Deletes the specified action group.
CompletableFuture<DeleteActionGroupResponse>	deleteActionGroup(DeleteActionGroupRequest request)	Deletes the specified action group.
final CompletableFuture<DeleteDistinguishedNameResponse>	deleteDistinguishedName(Function<DeleteDistinguishedNameRequest.Builder,ObjectBuilder<DeleteDistinguishedNameRequest>> fn)	Deletes all distinguished names in the specified cluster or node allowlist.
CompletableFuture<DeleteDistinguishedNameResponse>	deleteDistinguishedName(DeleteDistinguishedNameRequest request)	Deletes all distinguished names in the specified cluster or node allowlist.
final CompletableFuture<DeleteRoleResponse>	deleteRole(Function<DeleteRoleRequest.Builder,ObjectBuilder<DeleteRoleRequest>> fn)	Deletes the specified role.
CompletableFuture<DeleteRoleResponse>	deleteRole(DeleteRoleRequest request)	Deletes the specified role.
final CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(Function<DeleteRoleMappingRequest.Builder,ObjectBuilder<DeleteRoleMappingRequest>> fn)	Deletes the specified role mapping.
CompletableFuture<DeleteRoleMappingResponse>	deleteRoleMapping(DeleteRoleMappingRequest request)	Deletes the specified role mapping.
final CompletableFuture<DeleteTenantResponse>	deleteTenant(Function<DeleteTenantRequest.Builder,ObjectBuilder<DeleteTenantRequest>> fn)	Deletes the specified tenant.
CompletableFuture<DeleteTenantResponse>	deleteTenant(DeleteTenantRequest request)	Deletes the specified tenant.
final CompletableFuture<DeleteUserResponse>	deleteUser(Function<DeleteUserRequest.Builder,ObjectBuilder<DeleteUserRequest>> fn)	Deletes the specified internal user.
CompletableFuture<DeleteUserResponse>	deleteUser(DeleteUserRequest request)	Deletes the specified internal user.
final CompletableFuture<DeleteUserLegacyResponse>	deleteUserLegacy(Function<DeleteUserLegacyRequest.Builder,ObjectBuilder<DeleteUserLegacyRequest>> fn)	Delete the specified user.
CompletableFuture<DeleteUserLegacyResponse>	deleteUserLegacy(DeleteUserLegacyRequest request)	Delete the specified user.
final CompletableFuture<FlushCacheResponse>	flushCache()	Flushes the Security plugin's user, authentication, and authorization cache.
final CompletableFuture<FlushCacheResponse>	flushCache(Function<FlushCacheRequest.Builder,ObjectBuilder<FlushCacheRequest>> fn)	Flushes the Security plugin's user, authentication, and authorization cache.
CompletableFuture<FlushCacheResponse>	flushCache(FlushCacheRequest request)	Flushes the Security plugin's user, authentication, and authorization cache.
final CompletableFuture<GenerateOboTokenResponse>	generateOboToken(Function<GenerateOboTokenRequest.Builder,ObjectBuilder<GenerateOboTokenRequest>> fn)	Generates a On-Behalf-Of token for the current user.
CompletableFuture<GenerateOboTokenResponse>	generateOboToken(GenerateOboTokenRequest request)	Generates a On-Behalf-Of token for the current user.
final CompletableFuture<GenerateUserTokenResponse>	generateUserToken(Function<GenerateUserTokenRequest.Builder,ObjectBuilder<GenerateUserTokenRequest>> fn)	Generates an authorization token for the specified user.
CompletableFuture<GenerateUserTokenResponse>	generateUserToken(GenerateUserTokenRequest request)	Generates an authorization token for the specified user.
final CompletableFuture<BooleanResponse>	generateUserTokenLegacy(Function<GenerateUserTokenLegacyRequest.Builder,ObjectBuilder<GenerateUserTokenLegacyRequest>> fn)	Generates authorization token for the given user.
CompletableFuture<BooleanResponse>	generateUserTokenLegacy(GenerateUserTokenLegacyRequest request)	Generates authorization token for the given user.
final CompletableFuture<GetAccountDetailsResponse>	getAccountDetails()	Returns account information for the current user.
final CompletableFuture<GetAccountDetailsResponse>	getAccountDetails(Function<GetAccountDetailsRequest.Builder,ObjectBuilder<GetAccountDetailsRequest>> fn)	Returns account information for the current user.
CompletableFuture<GetAccountDetailsResponse>	getAccountDetails(GetAccountDetailsRequest request)	Returns account information for the current user.
final CompletableFuture<GetActionGroupResponse>	getActionGroup(Function<GetActionGroupRequest.Builder,ObjectBuilder<GetActionGroupRequest>> fn)	Retrieves one action group.
CompletableFuture<GetActionGroupResponse>	getActionGroup(GetActionGroupRequest request)	Retrieves one action group.
final CompletableFuture<GetActionGroupsResponse>	getActionGroups()	Retrieves all action groups.
final CompletableFuture<GetActionGroupsResponse>	getActionGroups(Function<GetActionGroupsRequest.Builder,ObjectBuilder<GetActionGroupsRequest>> fn)	Retrieves all action groups.
CompletableFuture<GetActionGroupsResponse>	getActionGroups(GetActionGroupsRequest request)	Retrieves all action groups.
final CompletableFuture<GetAllCertificatesResponse>	getAllCertificates()	Retrieves the cluster security certificates.
final CompletableFuture<GetAllCertificatesResponse>	getAllCertificates(Function<GetAllCertificatesRequest.Builder,ObjectBuilder<GetAllCertificatesRequest>> fn)	Retrieves the cluster security certificates.
CompletableFuture<GetAllCertificatesResponse>	getAllCertificates(GetAllCertificatesRequest request)	Retrieves the cluster security certificates.
final CompletableFuture<GetAllowlistResponse>	getAllowlist()	Retrieves the current list of allowed APIs accessible to a normal user.
final CompletableFuture<GetAllowlistResponse>	getAllowlist(Function<GetAllowlistRequest.Builder,ObjectBuilder<GetAllowlistRequest>> fn)	Retrieves the current list of allowed APIs accessible to a normal user.
CompletableFuture<GetAllowlistResponse>	getAllowlist(GetAllowlistRequest request)	Retrieves the current list of allowed APIs accessible to a normal user.
final CompletableFuture<GetAuditConfigurationResponse>	getAuditConfiguration()	Retrieves the audit configuration.
final CompletableFuture<GetAuditConfigurationResponse>	getAuditConfiguration(Function<GetAuditConfigurationRequest.Builder,ObjectBuilder<GetAuditConfigurationRequest>> fn)	Retrieves the audit configuration.
CompletableFuture<GetAuditConfigurationResponse>	getAuditConfiguration(GetAuditConfigurationRequest request)	Retrieves the audit configuration.
final CompletableFuture<GetCertificatesResponse>	getCertificates()	Retrieves the cluster security certificates.
final CompletableFuture<GetCertificatesResponse>	getCertificates(Function<GetCertificatesRequest.Builder,ObjectBuilder<GetCertificatesRequest>> fn)	Retrieves the cluster security certificates.
CompletableFuture<GetCertificatesResponse>	getCertificates(GetCertificatesRequest request)	Retrieves the cluster security certificates.
final CompletableFuture<GetConfigurationResponse>	getConfiguration()	Returns the current Security plugin configuration in a JSON format.
final CompletableFuture<GetConfigurationResponse>	getConfiguration(Function<GetConfigurationRequest.Builder,ObjectBuilder<GetConfigurationRequest>> fn)	Returns the current Security plugin configuration in a JSON format.
CompletableFuture<GetConfigurationResponse>	getConfiguration(GetConfigurationRequest request)	Returns the current Security plugin configuration in a JSON format.
final CompletableFuture<GetDashboardsInfoResponse>	getDashboardsInfo()	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
final CompletableFuture<GetDashboardsInfoResponse>	getDashboardsInfo(Function<GetDashboardsInfoRequest.Builder,ObjectBuilder<GetDashboardsInfoRequest>> fn)	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
CompletableFuture<GetDashboardsInfoResponse>	getDashboardsInfo(GetDashboardsInfoRequest request)	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
final CompletableFuture<GetDistinguishedNameResponse>	getDistinguishedName(Function<GetDistinguishedNameRequest.Builder,ObjectBuilder<GetDistinguishedNameRequest>> fn)	Retrieves all node distinguished names.
CompletableFuture<GetDistinguishedNameResponse>	getDistinguishedName(GetDistinguishedNameRequest request)	Retrieves all node distinguished names.
final CompletableFuture<GetDistinguishedNamesResponse>	getDistinguishedNames()	Retrieves all node distinguished names.
final CompletableFuture<GetDistinguishedNamesResponse>	getDistinguishedNames(Function<GetDistinguishedNamesRequest.Builder,ObjectBuilder<GetDistinguishedNamesRequest>> fn)	Retrieves all node distinguished names.
CompletableFuture<GetDistinguishedNamesResponse>	getDistinguishedNames(GetDistinguishedNamesRequest request)	Retrieves all node distinguished names.
final CompletableFuture<GetNodeCertificatesResponse>	getNodeCertificates(Function<GetNodeCertificatesRequest.Builder,ObjectBuilder<GetNodeCertificatesRequest>> fn)	Retrieves the specified node's security certificates.
CompletableFuture<GetNodeCertificatesResponse>	getNodeCertificates(GetNodeCertificatesRequest request)	Retrieves the specified node's security certificates.
final CompletableFuture<GetPermissionsInfoResponse>	getPermissionsInfo()	Retrieves the evaluated REST API permissions for the currently logged in user.
final CompletableFuture<GetPermissionsInfoResponse>	getPermissionsInfo(Function<GetPermissionsInfoRequest.Builder,ObjectBuilder<GetPermissionsInfoRequest>> fn)	Retrieves the evaluated REST API permissions for the currently logged in user.
CompletableFuture<GetPermissionsInfoResponse>	getPermissionsInfo(GetPermissionsInfoRequest request)	Retrieves the evaluated REST API permissions for the currently logged in user.
final CompletableFuture<GetRoleResponse>	getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)	Retrieves one role.
CompletableFuture<GetRoleResponse>	getRole(GetRoleRequest request)	Retrieves one role.
final CompletableFuture<GetRoleMappingResponse>	getRoleMapping(Function<GetRoleMappingRequest.Builder,ObjectBuilder<GetRoleMappingRequest>> fn)	Retrieves the specified role mapping.
CompletableFuture<GetRoleMappingResponse>	getRoleMapping(GetRoleMappingRequest request)	Retrieves the specified role mapping.
final CompletableFuture<GetRoleMappingsResponse>	getRoleMappings()	Retrieves all role mappings.
final CompletableFuture<GetRoleMappingsResponse>	getRoleMappings(Function<GetRoleMappingsRequest.Builder,ObjectBuilder<GetRoleMappingsRequest>> fn)	Retrieves all role mappings.
CompletableFuture<GetRoleMappingsResponse>	getRoleMappings(GetRoleMappingsRequest request)	Retrieves all role mappings.
final CompletableFuture<GetRolesResponse>	getRoles()	Retrieves all roles.
final CompletableFuture<GetRolesResponse>	getRoles(Function<GetRolesRequest.Builder,ObjectBuilder<GetRolesRequest>> fn)	Retrieves all roles.
CompletableFuture<GetRolesResponse>	getRoles(GetRolesRequest request)	Retrieves all roles.
final CompletableFuture<GetSslinfoResponse>	getSslinfo()	Retrieves information about the SSL configuration.
final CompletableFuture<GetSslinfoResponse>	getSslinfo(Function<GetSslinfoRequest.Builder,ObjectBuilder<GetSslinfoRequest>> fn)	Retrieves information about the SSL configuration.
CompletableFuture<GetSslinfoResponse>	getSslinfo(GetSslinfoRequest request)	Retrieves information about the SSL configuration.
final CompletableFuture<GetTenancyConfigResponse>	getTenancyConfig()	Retrieves the multi-tenancy configuration.
final CompletableFuture<GetTenancyConfigResponse>	getTenancyConfig(Function<GetTenancyConfigRequest.Builder,ObjectBuilder<GetTenancyConfigRequest>> fn)	Retrieves the multi-tenancy configuration.
CompletableFuture<GetTenancyConfigResponse>	getTenancyConfig(GetTenancyConfigRequest request)	Retrieves the multi-tenancy configuration.
final CompletableFuture<GetTenantResponse>	getTenant(Function<GetTenantRequest.Builder,ObjectBuilder<GetTenantRequest>> fn)	Retrieves the specified tenant.
CompletableFuture<GetTenantResponse>	getTenant(GetTenantRequest request)	Retrieves the specified tenant.
final CompletableFuture<GetTenantsResponse>	getTenants()	Retrieves all tenants.
final CompletableFuture<GetTenantsResponse>	getTenants(Function<GetTenantsRequest.Builder,ObjectBuilder<GetTenantsRequest>> fn)	Retrieves all tenants.
CompletableFuture<GetTenantsResponse>	getTenants(GetTenantsRequest request)	Retrieves all tenants.
final CompletableFuture<GetUserResponse>	getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)	Retrieve information about the specified internal user.
CompletableFuture<GetUserResponse>	getUser(GetUserRequest request)	Retrieve information about the specified internal user.
final CompletableFuture<GetUserLegacyResponse>	getUserLegacy(Function<GetUserLegacyRequest.Builder,ObjectBuilder<GetUserLegacyRequest>> fn)	Retrieve one user.
CompletableFuture<GetUserLegacyResponse>	getUserLegacy(GetUserLegacyRequest request)	Retrieve one user.
final CompletableFuture<GetUsersResponse>	getUsers()	Retrieve all internal users.
final CompletableFuture<GetUsersResponse>	getUsers(Function<GetUsersRequest.Builder,ObjectBuilder<GetUsersRequest>> fn)	Retrieve all internal users.
CompletableFuture<GetUsersResponse>	getUsers(GetUsersRequest request)	Retrieve all internal users.
final CompletableFuture<GetUsersLegacyResponse>	getUsersLegacy()	Retrieve all internal users.
final CompletableFuture<GetUsersLegacyResponse>	getUsersLegacy(Function<GetUsersLegacyRequest.Builder,ObjectBuilder<GetUsersLegacyRequest>> fn)	Retrieve all internal users.
CompletableFuture<GetUsersLegacyResponse>	getUsersLegacy(GetUsersLegacyRequest request)	Retrieve all internal users.
final CompletableFuture<HealthResponse>	health()	Checks to see if the Security plugin is running.
final CompletableFuture<HealthResponse>	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Checks to see if the Security plugin is running.
CompletableFuture<HealthResponse>	health(HealthRequest request)	Checks to see if the Security plugin is running.
final CompletableFuture<MigrateResponse>	migrate()	Migrates the security configuration from v6 to v7.
final CompletableFuture<MigrateResponse>	migrate(Function<MigrateRequest.Builder,ObjectBuilder<MigrateRequest>> fn)	Migrates the security configuration from v6 to v7.
CompletableFuture<MigrateResponse>	migrate(MigrateRequest request)	Migrates the security configuration from v6 to v7.
final CompletableFuture<PatchActionGroupResponse>	patchActionGroup(Function<PatchActionGroupRequest.Builder,ObjectBuilder<PatchActionGroupRequest>> fn)	Updates the individual attributes of an action group.
CompletableFuture<PatchActionGroupResponse>	patchActionGroup(PatchActionGroupRequest request)	Updates the individual attributes of an action group.
final CompletableFuture<PatchActionGroupsResponse>	patchActionGroups(Function<PatchActionGroupsRequest.Builder,ObjectBuilder<PatchActionGroupsRequest>> fn)	Creates, updates, or deletes multiple action groups in a single request.
CompletableFuture<PatchActionGroupsResponse>	patchActionGroups(PatchActionGroupsRequest request)	Creates, updates, or deletes multiple action groups in a single request.
final CompletableFuture<PatchAllowlistResponse>	patchAllowlist(Function<PatchAllowlistRequest.Builder,ObjectBuilder<PatchAllowlistRequest>> fn)	Updates the current list of APIs accessible for users on the allow list.
CompletableFuture<PatchAllowlistResponse>	patchAllowlist(PatchAllowlistRequest request)	Updates the current list of APIs accessible for users on the allow list.
final CompletableFuture<PatchAuditConfigurationResponse>	patchAuditConfiguration(Function<PatchAuditConfigurationRequest.Builder,ObjectBuilder<PatchAuditConfigurationRequest>> fn)	Updates the specified fields in the audit configuration.
CompletableFuture<PatchAuditConfigurationResponse>	patchAuditConfiguration(PatchAuditConfigurationRequest request)	Updates the specified fields in the audit configuration.
final CompletableFuture<PatchConfigurationResponse>	patchConfiguration(Function<PatchConfigurationRequest.Builder,ObjectBuilder<PatchConfigurationRequest>> fn)	Updates the existing security configuration using the REST API.
CompletableFuture<PatchConfigurationResponse>	patchConfiguration(PatchConfigurationRequest request)	Updates the existing security configuration using the REST API.
final CompletableFuture<PatchDistinguishedNameResponse>	patchDistinguishedName(Function<PatchDistinguishedNameRequest.Builder,ObjectBuilder<PatchDistinguishedNameRequest>> fn)	Updates the distinguished cluster name for the specified cluster.
CompletableFuture<PatchDistinguishedNameResponse>	patchDistinguishedName(PatchDistinguishedNameRequest request)	Updates the distinguished cluster name for the specified cluster.
final CompletableFuture<PatchDistinguishedNamesResponse>	patchDistinguishedNames(Function<PatchDistinguishedNamesRequest.Builder,ObjectBuilder<PatchDistinguishedNamesRequest>> fn)	Bulk updates specified node distinguished names.
CompletableFuture<PatchDistinguishedNamesResponse>	patchDistinguishedNames(PatchDistinguishedNamesRequest request)	Bulk updates specified node distinguished names.
final CompletableFuture<PatchRoleResponse>	patchRole(Function<PatchRoleRequest.Builder,ObjectBuilder<PatchRoleRequest>> fn)	Updates the individual attributes of a role.
CompletableFuture<PatchRoleResponse>	patchRole(PatchRoleRequest request)	Updates the individual attributes of a role.
final CompletableFuture<PatchRoleMappingResponse>	patchRoleMapping(Function<PatchRoleMappingRequest.Builder,ObjectBuilder<PatchRoleMappingRequest>> fn)	Updates the individual attributes of a role mapping.
CompletableFuture<PatchRoleMappingResponse>	patchRoleMapping(PatchRoleMappingRequest request)	Updates the individual attributes of a role mapping.
final CompletableFuture<PatchRoleMappingsResponse>	patchRoleMappings(Function<PatchRoleMappingsRequest.Builder,ObjectBuilder<PatchRoleMappingsRequest>> fn)	Creates or updates multiple role mappings in a single request.
CompletableFuture<PatchRoleMappingsResponse>	patchRoleMappings(PatchRoleMappingsRequest request)	Creates or updates multiple role mappings in a single request.
final CompletableFuture<PatchRolesResponse>	patchRoles(Function<PatchRolesRequest.Builder,ObjectBuilder<PatchRolesRequest>> fn)	Creates, updates, or deletes multiple roles in a single call.
CompletableFuture<PatchRolesResponse>	patchRoles(PatchRolesRequest request)	Creates, updates, or deletes multiple roles in a single call.
final CompletableFuture<PatchTenantResponse>	patchTenant(Function<PatchTenantRequest.Builder,ObjectBuilder<PatchTenantRequest>> fn)	Adds, deletes, or modifies a single tenant.
CompletableFuture<PatchTenantResponse>	patchTenant(PatchTenantRequest request)	Adds, deletes, or modifies a single tenant.
final CompletableFuture<PatchTenantsResponse>	patchTenants(Function<PatchTenantsRequest.Builder,ObjectBuilder<PatchTenantsRequest>> fn)	Adds, deletes, or modifies multiple tenants in a single request.
CompletableFuture<PatchTenantsResponse>	patchTenants(PatchTenantsRequest request)	Adds, deletes, or modifies multiple tenants in a single request.
final CompletableFuture<PatchUserResponse>	patchUser(Function<PatchUserRequest.Builder,ObjectBuilder<PatchUserRequest>> fn)	Updates individual attributes for an internal user.
CompletableFuture<PatchUserResponse>	patchUser(PatchUserRequest request)	Updates individual attributes for an internal user.
final CompletableFuture<PatchUsersResponse>	patchUsers(Function<PatchUsersRequest.Builder,ObjectBuilder<PatchUsersRequest>> fn)	Creates, updates, or deletes multiple internal users in a single request.
CompletableFuture<PatchUsersResponse>	patchUsers(PatchUsersRequest request)	Creates, updates, or deletes multiple internal users in a single request.
final CompletableFuture<PostDashboardsInfoResponse>	postDashboardsInfo()	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
final CompletableFuture<PostDashboardsInfoResponse>	postDashboardsInfo(Function<PostDashboardsInfoRequest.Builder,ObjectBuilder<PostDashboardsInfoRequest>> fn)	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
CompletableFuture<PostDashboardsInfoResponse>	postDashboardsInfo(PostDashboardsInfoRequest request)	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
final CompletableFuture<ReloadHttpCertificatesResponse>	reloadHttpCertificates()	Reloads the HTTP communication certificates.
final CompletableFuture<ReloadHttpCertificatesResponse>	reloadHttpCertificates(Function<ReloadHttpCertificatesRequest.Builder,ObjectBuilder<ReloadHttpCertificatesRequest>> fn)	Reloads the HTTP communication certificates.
CompletableFuture<ReloadHttpCertificatesResponse>	reloadHttpCertificates(ReloadHttpCertificatesRequest request)	Reloads the HTTP communication certificates.
final CompletableFuture<ReloadTransportCertificatesResponse>	reloadTransportCertificates()	Reloads the transport communication certificates.
final CompletableFuture<ReloadTransportCertificatesResponse>	reloadTransportCertificates(Function<ReloadTransportCertificatesRequest.Builder,ObjectBuilder<ReloadTransportCertificatesRequest>> fn)	Reloads the transport communication certificates.
CompletableFuture<ReloadTransportCertificatesResponse>	reloadTransportCertificates(ReloadTransportCertificatesRequest request)	Reloads the transport communication certificates.
final CompletableFuture<TenantInfoResponse>	tenantInfo()	Retrieves the names of current tenants.
final CompletableFuture<TenantInfoResponse>	tenantInfo(Function<TenantInfoRequest.Builder,ObjectBuilder<TenantInfoRequest>> fn)	Retrieves the names of current tenants.
CompletableFuture<TenantInfoResponse>	tenantInfo(TenantInfoRequest request)	Retrieves the names of current tenants.
final CompletableFuture<UpdateAuditConfigurationResponse>	updateAuditConfiguration()	Updates the audit configuration.
final CompletableFuture<UpdateAuditConfigurationResponse>	updateAuditConfiguration(Function<UpdateAuditConfigurationRequest.Builder,ObjectBuilder<UpdateAuditConfigurationRequest>> fn)	Updates the audit configuration.
CompletableFuture<UpdateAuditConfigurationResponse>	updateAuditConfiguration(UpdateAuditConfigurationRequest request)	Updates the audit configuration.
final CompletableFuture<UpdateConfigurationResponse>	updateConfiguration()	Updates the settings for an existing security configuration.
final CompletableFuture<UpdateConfigurationResponse>	updateConfiguration(Function<UpdateConfigurationRequest.Builder,ObjectBuilder<UpdateConfigurationRequest>> fn)	Updates the settings for an existing security configuration.
CompletableFuture<UpdateConfigurationResponse>	updateConfiguration(UpdateConfigurationRequest request)	Updates the settings for an existing security configuration.
final CompletableFuture<UpdateDistinguishedNameResponse>	updateDistinguishedName(Function<UpdateDistinguishedNameRequest.Builder,ObjectBuilder<UpdateDistinguishedNameRequest>> fn)	Adds or updates the specified distinguished names in the cluster or node allowlist.
CompletableFuture<UpdateDistinguishedNameResponse>	updateDistinguishedName(UpdateDistinguishedNameRequest request)	Adds or updates the specified distinguished names in the cluster or node allowlist.
final CompletableFuture<ValidateResponse>	validate()	Checks whether the v6 security configuration is valid and ready to be migrated to v7.
final CompletableFuture<ValidateResponse>	validate(Function<ValidateRequest.Builder,ObjectBuilder<ValidateRequest>> fn)	Checks whether the v6 security configuration is valid and ready to be migrated to v7.
CompletableFuture<ValidateResponse>	validate(ValidateRequest request)	Checks whether the v6 security configuration is valid and ready to be migrated to v7.
final CompletableFuture<WhoAmIResponse>	whoAmI()	Gets the identity information for the user currently logged in.
final CompletableFuture<WhoAmIResponse>	whoAmI(Function<WhoAmIRequest.Builder,ObjectBuilder<WhoAmIRequest>> fn)	Gets the identity information for the user currently logged in.
CompletableFuture<WhoAmIResponse>	whoAmI(WhoAmIRequest request)	Gets the identity information for the user currently logged in.
final CompletableFuture<WhoAmIProtectedResponse>	whoAmIProtected()	Gets the identity information for the user currently logged in.
final CompletableFuture<WhoAmIProtectedResponse>	whoAmIProtected(Function<WhoAmIProtectedRequest.Builder,ObjectBuilder<WhoAmIProtectedRequest>> fn)	Gets the identity information for the user currently logged in.
CompletableFuture<WhoAmIProtectedResponse>	whoAmIProtected(WhoAmIProtectedRequest request)	Gets the identity information for the user currently logged in.
OpenSearchSecurityAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchSecurityAsyncClient

public OpenSearchSecurityAsyncClient(OpenSearchTransport transport)

OpenSearchSecurityAsyncClient

public OpenSearchSecurityAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSecurityAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSecurityAsyncClient>

authinfo

public CompletableFuture<AuthinfoResponse> authinfo(AuthinfoRequest request)
                                             throws IOException,
OpenSearchException

Returns or updates authentication information for the currently authenticated user.

Throws:

IOException

OpenSearchException

authinfo

public final CompletableFuture<AuthinfoResponse> authinfo(Function<AuthinfoRequest.Builder,ObjectBuilder<AuthinfoRequest>> fn)
                                                   throws IOException,
OpenSearchException

Returns or updates authentication information for the currently authenticated user.

Parameters:

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

Throws:

IOException

OpenSearchException

authinfo

public final CompletableFuture<AuthinfoResponse> authinfo()
                                                   throws IOException,
OpenSearchException

Returns or updates authentication information for the currently authenticated user.

Throws:

IOException

OpenSearchException

authtoken

public CompletableFuture<AuthtokenResponse> authtoken(AuthtokenRequest request)
                                               throws IOException,
OpenSearchException

Returns the authorization token for the current user.

Throws:

IOException

OpenSearchException

authtoken

public final CompletableFuture<AuthtokenResponse> authtoken(Function<AuthtokenRequest.Builder,ObjectBuilder<AuthtokenRequest>> fn)
                                                     throws IOException,
OpenSearchException

Returns the authorization token for the current user.

Parameters:

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

Throws:

IOException

OpenSearchException

authtoken

public final CompletableFuture<AuthtokenResponse> authtoken()
                                                     throws IOException,
OpenSearchException

Returns the authorization token for the current user.

Throws:

IOException

OpenSearchException

changePassword

public CompletableFuture<ChangePasswordResponse> changePassword(ChangePasswordRequest request)
                                                         throws IOException,
OpenSearchException

Changes the password for the current user.

Throws:

IOException

OpenSearchException

changePassword

public final CompletableFuture<ChangePasswordResponse> changePassword(Function<ChangePasswordRequest.Builder,ObjectBuilder<ChangePasswordRequest>> fn)
                                                               throws IOException,
OpenSearchException

Changes the password for the current user.

Parameters:

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

Throws:

IOException

OpenSearchException

configUpgradeCheck

public CompletableFuture<ConfigUpgradeCheckResponse> configUpgradeCheck(ConfigUpgradeCheckRequest request)
                                                                 throws IOException,
OpenSearchException

Checks whether or not an upgrade can be performed and which security resources can be updated.

Throws:

IOException

OpenSearchException

configUpgradeCheck

public final CompletableFuture<ConfigUpgradeCheckResponse> configUpgradeCheck(Function<ConfigUpgradeCheckRequest.Builder,ObjectBuilder<ConfigUpgradeCheckRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Checks whether or not an upgrade can be performed and which security resources can be updated.

Parameters:

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

Throws:

IOException

OpenSearchException

configUpgradeCheck

public final CompletableFuture<ConfigUpgradeCheckResponse> configUpgradeCheck()
                                                                       throws IOException,
OpenSearchException

Checks whether or not an upgrade can be performed and which security resources can be updated.

Throws:

IOException

OpenSearchException

configUpgradePerform

public CompletableFuture<ConfigUpgradePerformResponse> configUpgradePerform(ConfigUpgradePerformRequest request)
                                                                     throws IOException,
OpenSearchException

Assists the cluster operator with upgrading missing default values and stale default definitions.

Throws:

IOException

OpenSearchException

configUpgradePerform

public final CompletableFuture<ConfigUpgradePerformResponse> configUpgradePerform(Function<ConfigUpgradePerformRequest.Builder,ObjectBuilder<ConfigUpgradePerformRequest>> fn)
                                                                           throws IOException,
OpenSearchException

Assists the cluster operator with upgrading missing default values and stale default definitions.

Parameters:

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

Throws:

IOException

OpenSearchException

configUpgradePerform

public final CompletableFuture<ConfigUpgradePerformResponse> configUpgradePerform()
                                                                           throws IOException,
OpenSearchException

Assists the cluster operator with upgrading missing default values and stale default definitions.

Throws:

IOException

OpenSearchException

createActionGroup

public CompletableFuture<CreateActionGroupResponse> createActionGroup(CreateActionGroupRequest request)
                                                               throws IOException,
OpenSearchException

Creates or replaces the specified action group.

Throws:

IOException

OpenSearchException

createActionGroup

public final CompletableFuture<CreateActionGroupResponse> createActionGroup(Function<CreateActionGroupRequest.Builder,ObjectBuilder<CreateActionGroupRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Creates or replaces the specified action group.

Parameters:

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

Throws:

IOException

OpenSearchException

createAllowlist

public CompletableFuture<CreateAllowlistResponse> createAllowlist(CreateAllowlistRequest request)
                                                           throws IOException,
OpenSearchException

Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.

Throws:

IOException

OpenSearchException

createAllowlist

public final CompletableFuture<CreateAllowlistResponse> createAllowlist(Function<CreateAllowlistRequest.Builder,ObjectBuilder<CreateAllowlistRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

createAllowlist

public final CompletableFuture<CreateAllowlistResponse> createAllowlist()
                                                                 throws IOException,
OpenSearchException

Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.

Throws:

IOException

OpenSearchException

createRole

public CompletableFuture<CreateRoleResponse> createRole(CreateRoleRequest request)
                                                 throws IOException,
OpenSearchException

Creates or replaces the specified role.

Throws:

IOException

OpenSearchException

createRole

public final CompletableFuture<CreateRoleResponse> createRole(Function<CreateRoleRequest.Builder,ObjectBuilder<CreateRoleRequest>> fn)
                                                       throws IOException,
OpenSearchException

Creates or replaces the specified role.

Parameters:

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

Throws:

IOException

OpenSearchException

createRoleMapping

public CompletableFuture<CreateRoleMappingResponse> createRoleMapping(CreateRoleMappingRequest request)
                                                               throws IOException,
OpenSearchException

Creates or replaces the specified role mapping.

Throws:

IOException

OpenSearchException

createRoleMapping

public final CompletableFuture<CreateRoleMappingResponse> createRoleMapping(Function<CreateRoleMappingRequest.Builder,ObjectBuilder<CreateRoleMappingRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Creates or replaces the specified role mapping.

Parameters:

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

Throws:

IOException

OpenSearchException

createTenant

public CompletableFuture<CreateTenantResponse> createTenant(CreateTenantRequest request)
                                                     throws IOException,
OpenSearchException

Creates or replaces the specified tenant.

Throws:

IOException

OpenSearchException

createTenant

public final CompletableFuture<CreateTenantResponse> createTenant(Function<CreateTenantRequest.Builder,ObjectBuilder<CreateTenantRequest>> fn)
                                                           throws IOException,
OpenSearchException

Creates or replaces the specified tenant.

Parameters:

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

Throws:

IOException

OpenSearchException

createUpdateTenancyConfig

public CompletableFuture<CreateUpdateTenancyConfigResponse> createUpdateTenancyConfig(CreateUpdateTenancyConfigRequest request)
                                                                               throws IOException,
OpenSearchException

Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

createUpdateTenancyConfig

public final CompletableFuture<CreateUpdateTenancyConfigResponse> createUpdateTenancyConfig(Function<CreateUpdateTenancyConfigRequest.Builder,ObjectBuilder<CreateUpdateTenancyConfigRequest>> fn)
                                                                                     throws IOException,
OpenSearchException

Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

createUpdateTenancyConfig

public final CompletableFuture<CreateUpdateTenancyConfigResponse> createUpdateTenancyConfig()
                                                                                     throws IOException,
OpenSearchException

Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

createUser

public CompletableFuture<CreateUserResponse> createUser(CreateUserRequest request)
                                                 throws IOException,
OpenSearchException

Creates or replaces the specified user.

Throws:

IOException

OpenSearchException

createUser

public final CompletableFuture<CreateUserResponse> createUser(Function<CreateUserRequest.Builder,ObjectBuilder<CreateUserRequest>> fn)
                                                       throws IOException,
OpenSearchException

Creates or replaces the specified user.

Parameters:

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

Throws:

IOException

OpenSearchException

createUserLegacy

public CompletableFuture<CreateUserLegacyResponse> createUserLegacy(CreateUserLegacyRequest request)
                                                             throws IOException,
OpenSearchException

Creates or replaces the specified user. Legacy API.

Throws:

IOException

OpenSearchException

createUserLegacy

public final CompletableFuture<CreateUserLegacyResponse> createUserLegacy(Function<CreateUserLegacyRequest.Builder,ObjectBuilder<CreateUserLegacyRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Creates or replaces the specified user. Legacy API.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteActionGroup

public CompletableFuture<DeleteActionGroupResponse> deleteActionGroup(DeleteActionGroupRequest request)
                                                               throws IOException,
OpenSearchException

Deletes the specified action group.

Throws:

IOException

OpenSearchException

deleteActionGroup

public final CompletableFuture<DeleteActionGroupResponse> deleteActionGroup(Function<DeleteActionGroupRequest.Builder,ObjectBuilder<DeleteActionGroupRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Deletes the specified action group.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteDistinguishedName

public CompletableFuture<DeleteDistinguishedNameResponse> deleteDistinguishedName(DeleteDistinguishedNameRequest request)
                                                                           throws IOException,
OpenSearchException

Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

deleteDistinguishedName

public final CompletableFuture<DeleteDistinguishedNameResponse> deleteDistinguishedName(Function<DeleteDistinguishedNameRequest.Builder,ObjectBuilder<DeleteDistinguishedNameRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteRole

public CompletableFuture<DeleteRoleResponse> deleteRole(DeleteRoleRequest request)
                                                 throws IOException,
OpenSearchException

Deletes the specified role.

Throws:

IOException

OpenSearchException

deleteRole

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

Deletes the specified role.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteRoleMapping

public CompletableFuture<DeleteRoleMappingResponse> deleteRoleMapping(DeleteRoleMappingRequest request)
                                                               throws IOException,
OpenSearchException

Deletes the specified role mapping.

Throws:

IOException

OpenSearchException

deleteRoleMapping

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

Deletes the specified role mapping.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteTenant

public CompletableFuture<DeleteTenantResponse> deleteTenant(DeleteTenantRequest request)
                                                     throws IOException,
OpenSearchException

Deletes the specified tenant.

Throws:

IOException

OpenSearchException

deleteTenant

public final CompletableFuture<DeleteTenantResponse> deleteTenant(Function<DeleteTenantRequest.Builder,ObjectBuilder<DeleteTenantRequest>> fn)
                                                           throws IOException,
OpenSearchException

Deletes the specified tenant.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteUser

public CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest request)
                                                 throws IOException,
OpenSearchException

Deletes the specified internal user.

Throws:

IOException

OpenSearchException

deleteUser

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

Deletes the specified internal user.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteUserLegacy

public CompletableFuture<DeleteUserLegacyResponse> deleteUserLegacy(DeleteUserLegacyRequest request)
                                                             throws IOException,
OpenSearchException

Delete the specified user. Legacy API.

Throws:

IOException

OpenSearchException

deleteUserLegacy

public final CompletableFuture<DeleteUserLegacyResponse> deleteUserLegacy(Function<DeleteUserLegacyRequest.Builder,ObjectBuilder<DeleteUserLegacyRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Delete the specified user. Legacy API.

Parameters:

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

Throws:

IOException

OpenSearchException

flushCache

public CompletableFuture<FlushCacheResponse> flushCache(FlushCacheRequest request)
                                                 throws IOException,
OpenSearchException

Flushes the Security plugin's user, authentication, and authorization cache.

Throws:

IOException

OpenSearchException

flushCache

public final CompletableFuture<FlushCacheResponse> flushCache(Function<FlushCacheRequest.Builder,ObjectBuilder<FlushCacheRequest>> fn)
                                                       throws IOException,
OpenSearchException

Flushes the Security plugin's user, authentication, and authorization cache.

Parameters:

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

Throws:

IOException

OpenSearchException

flushCache

public final CompletableFuture<FlushCacheResponse> flushCache()
                                                       throws IOException,
OpenSearchException

Flushes the Security plugin's user, authentication, and authorization cache.

Throws:

IOException

OpenSearchException

generateOboToken

public CompletableFuture<GenerateOboTokenResponse> generateOboToken(GenerateOboTokenRequest request)
                                                             throws IOException,
OpenSearchException

Generates a On-Behalf-Of token for the current user.

Throws:

IOException

OpenSearchException

generateOboToken

public final CompletableFuture<GenerateOboTokenResponse> generateOboToken(Function<GenerateOboTokenRequest.Builder,ObjectBuilder<GenerateOboTokenRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Generates a On-Behalf-Of token for the current user.

Parameters:

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

Throws:

IOException

OpenSearchException

generateUserToken

public CompletableFuture<GenerateUserTokenResponse> generateUserToken(GenerateUserTokenRequest request)
                                                               throws IOException,
OpenSearchException

Generates an authorization token for the specified user.

Throws:

IOException

OpenSearchException

generateUserToken

public final CompletableFuture<GenerateUserTokenResponse> generateUserToken(Function<GenerateUserTokenRequest.Builder,ObjectBuilder<GenerateUserTokenRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Generates an authorization token for the specified user.

Parameters:

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

Throws:

IOException

OpenSearchException

generateUserTokenLegacy

public CompletableFuture<BooleanResponse> generateUserTokenLegacy(GenerateUserTokenLegacyRequest request)
                                                           throws IOException,
OpenSearchException

Generates authorization token for the given user. Legacy API. Not Implemented.

Throws:

IOException

OpenSearchException

generateUserTokenLegacy

public final CompletableFuture<BooleanResponse> generateUserTokenLegacy(Function<GenerateUserTokenLegacyRequest.Builder,ObjectBuilder<GenerateUserTokenLegacyRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Generates authorization token for the given user. Legacy API. Not Implemented.

Parameters:

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

Throws:

IOException

OpenSearchException

getAccountDetails

public CompletableFuture<GetAccountDetailsResponse> getAccountDetails(GetAccountDetailsRequest request)
                                                               throws IOException,
OpenSearchException

Returns account information for the current user.

Throws:

IOException

OpenSearchException

getAccountDetails

public final CompletableFuture<GetAccountDetailsResponse> getAccountDetails(Function<GetAccountDetailsRequest.Builder,ObjectBuilder<GetAccountDetailsRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Returns account information for the current user.

Parameters:

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

Throws:

IOException

OpenSearchException

getAccountDetails

public final CompletableFuture<GetAccountDetailsResponse> getAccountDetails()
                                                                     throws IOException,
OpenSearchException

Returns account information for the current user.

Throws:

IOException

OpenSearchException

getActionGroup

public CompletableFuture<GetActionGroupResponse> getActionGroup(GetActionGroupRequest request)
                                                         throws IOException,
OpenSearchException

Retrieves one action group.

Throws:

IOException

OpenSearchException

getActionGroup

public final CompletableFuture<GetActionGroupResponse> getActionGroup(Function<GetActionGroupRequest.Builder,ObjectBuilder<GetActionGroupRequest>> fn)
                                                               throws IOException,
OpenSearchException

Retrieves one action group.

Parameters:

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

Throws:

IOException

OpenSearchException

getActionGroups

public CompletableFuture<GetActionGroupsResponse> getActionGroups(GetActionGroupsRequest request)
                                                           throws IOException,
OpenSearchException

Retrieves all action groups.

Throws:

IOException

OpenSearchException

getActionGroups

public final CompletableFuture<GetActionGroupsResponse> getActionGroups(Function<GetActionGroupsRequest.Builder,ObjectBuilder<GetActionGroupsRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Retrieves all action groups.

Parameters:

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

Throws:

IOException

OpenSearchException

getActionGroups

public final CompletableFuture<GetActionGroupsResponse> getActionGroups()
                                                                 throws IOException,
OpenSearchException

Retrieves all action groups.

Throws:

IOException

OpenSearchException

getAllCertificates

public CompletableFuture<GetAllCertificatesResponse> getAllCertificates(GetAllCertificatesRequest request)
                                                                 throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getAllCertificates

public final CompletableFuture<GetAllCertificatesResponse> getAllCertificates(Function<GetAllCertificatesRequest.Builder,ObjectBuilder<GetAllCertificatesRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Parameters:

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

Throws:

IOException

OpenSearchException

getAllCertificates

public final CompletableFuture<GetAllCertificatesResponse> getAllCertificates()
                                                                       throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getAllowlist

public CompletableFuture<GetAllowlistResponse> getAllowlist(GetAllowlistRequest request)
                                                     throws IOException,
OpenSearchException

Retrieves the current list of allowed APIs accessible to a normal user.

Throws:

IOException

OpenSearchException

getAllowlist

public final CompletableFuture<GetAllowlistResponse> getAllowlist(Function<GetAllowlistRequest.Builder,ObjectBuilder<GetAllowlistRequest>> fn)
                                                           throws IOException,
OpenSearchException

Retrieves the current list of allowed APIs accessible to a normal user.

Parameters:

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

Throws:

IOException

OpenSearchException

getAllowlist

public final CompletableFuture<GetAllowlistResponse> getAllowlist()
                                                           throws IOException,
OpenSearchException

Retrieves the current list of allowed APIs accessible to a normal user.

Throws:

IOException

OpenSearchException

getAuditConfiguration

public CompletableFuture<GetAuditConfigurationResponse> getAuditConfiguration(GetAuditConfigurationRequest request)
                                                                       throws IOException,
OpenSearchException

Retrieves the audit configuration.

Throws:

IOException

OpenSearchException

getAuditConfiguration

public final CompletableFuture<GetAuditConfigurationResponse> getAuditConfiguration(Function<GetAuditConfigurationRequest.Builder,ObjectBuilder<GetAuditConfigurationRequest>> fn)
                                                                             throws IOException,
OpenSearchException

Retrieves the audit configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

getAuditConfiguration

public final CompletableFuture<GetAuditConfigurationResponse> getAuditConfiguration()
                                                                             throws IOException,
OpenSearchException

Retrieves the audit configuration.

Throws:

IOException

OpenSearchException

getCertificates

public CompletableFuture<GetCertificatesResponse> getCertificates(GetCertificatesRequest request)
                                                           throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getCertificates

public final CompletableFuture<GetCertificatesResponse> getCertificates(Function<GetCertificatesRequest.Builder,ObjectBuilder<GetCertificatesRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Parameters:

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

Throws:

IOException

OpenSearchException

getCertificates

public final CompletableFuture<GetCertificatesResponse> getCertificates()
                                                                 throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getConfiguration

public CompletableFuture<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request)
                                                             throws IOException,
OpenSearchException

Returns the current Security plugin configuration in a JSON format.

Throws:

IOException

OpenSearchException

getConfiguration

public final CompletableFuture<GetConfigurationResponse> getConfiguration(Function<GetConfigurationRequest.Builder,ObjectBuilder<GetConfigurationRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Returns the current Security plugin configuration in a JSON format.

Parameters:

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

Throws:

IOException

OpenSearchException

getConfiguration

public final CompletableFuture<GetConfigurationResponse> getConfiguration()
                                                                   throws IOException,
OpenSearchException

Returns the current Security plugin configuration in a JSON format.

Throws:

IOException

OpenSearchException

getDashboardsInfo

public CompletableFuture<GetDashboardsInfoResponse> getDashboardsInfo(GetDashboardsInfoRequest request)
                                                               throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Throws:

IOException

OpenSearchException

getDashboardsInfo

public final CompletableFuture<GetDashboardsInfoResponse> getDashboardsInfo(Function<GetDashboardsInfoRequest.Builder,ObjectBuilder<GetDashboardsInfoRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Parameters:

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

Throws:

IOException

OpenSearchException

getDashboardsInfo

public final CompletableFuture<GetDashboardsInfoResponse> getDashboardsInfo()
                                                                     throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Throws:

IOException

OpenSearchException

getDistinguishedName

public CompletableFuture<GetDistinguishedNameResponse> getDistinguishedName(GetDistinguishedNameRequest request)
                                                                     throws IOException,
OpenSearchException

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

getDistinguishedName

public final CompletableFuture<GetDistinguishedNameResponse> getDistinguishedName(Function<GetDistinguishedNameRequest.Builder,ObjectBuilder<GetDistinguishedNameRequest>> fn)
                                                                           throws IOException,
OpenSearchException

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

getDistinguishedNames

public CompletableFuture<GetDistinguishedNamesResponse> getDistinguishedNames(GetDistinguishedNamesRequest request)
                                                                       throws IOException,
OpenSearchException

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

getDistinguishedNames

public final CompletableFuture<GetDistinguishedNamesResponse> getDistinguishedNames(Function<GetDistinguishedNamesRequest.Builder,ObjectBuilder<GetDistinguishedNamesRequest>> fn)
                                                                             throws IOException,
OpenSearchException

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

getDistinguishedNames

public final CompletableFuture<GetDistinguishedNamesResponse> getDistinguishedNames()
                                                                             throws IOException,
OpenSearchException

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

getNodeCertificates

public CompletableFuture<GetNodeCertificatesResponse> getNodeCertificates(GetNodeCertificatesRequest request)
                                                                   throws IOException,
OpenSearchException

Retrieves the specified node's security certificates.

Throws:

IOException

OpenSearchException

getNodeCertificates

public final CompletableFuture<GetNodeCertificatesResponse> getNodeCertificates(Function<GetNodeCertificatesRequest.Builder,ObjectBuilder<GetNodeCertificatesRequest>> fn)
                                                                         throws IOException,
OpenSearchException

Retrieves the specified node's security certificates.

Parameters:

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

Throws:

IOException

OpenSearchException

getPermissionsInfo

public CompletableFuture<GetPermissionsInfoResponse> getPermissionsInfo(GetPermissionsInfoRequest request)
                                                                 throws IOException,
OpenSearchException

Retrieves the evaluated REST API permissions for the currently logged in user.

Throws:

IOException

OpenSearchException

getPermissionsInfo

public final CompletableFuture<GetPermissionsInfoResponse> getPermissionsInfo(Function<GetPermissionsInfoRequest.Builder,ObjectBuilder<GetPermissionsInfoRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Retrieves the evaluated REST API permissions for the currently logged in user.

Parameters:

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

Throws:

IOException

OpenSearchException

getPermissionsInfo

public final CompletableFuture<GetPermissionsInfoResponse> getPermissionsInfo()
                                                                       throws IOException,
OpenSearchException

Retrieves the evaluated REST API permissions for the currently logged in user.

Throws:

IOException

OpenSearchException

getRole

public CompletableFuture<GetRoleResponse> getRole(GetRoleRequest request)
                                           throws IOException,
OpenSearchException

Retrieves one role.

Throws:

IOException

OpenSearchException

getRole

public final CompletableFuture<GetRoleResponse> getRole(Function<GetRoleRequest.Builder,ObjectBuilder<GetRoleRequest>> fn)
                                                 throws IOException,
OpenSearchException

Retrieves one role.

Parameters:

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

Throws:

IOException

OpenSearchException

getRoleMapping

public CompletableFuture<GetRoleMappingResponse> getRoleMapping(GetRoleMappingRequest request)
                                                         throws IOException,
OpenSearchException

Retrieves the specified role mapping.

Throws:

IOException

OpenSearchException

getRoleMapping

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

Retrieves the specified role mapping.

Parameters:

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

Throws:

IOException

OpenSearchException

getRoleMappings

public CompletableFuture<GetRoleMappingsResponse> getRoleMappings(GetRoleMappingsRequest request)
                                                           throws IOException,
OpenSearchException

Retrieves all role mappings.

Throws:

IOException

OpenSearchException

getRoleMappings

public final CompletableFuture<GetRoleMappingsResponse> getRoleMappings(Function<GetRoleMappingsRequest.Builder,ObjectBuilder<GetRoleMappingsRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Retrieves all role mappings.

Parameters:

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

Throws:

IOException

OpenSearchException

getRoleMappings

public final CompletableFuture<GetRoleMappingsResponse> getRoleMappings()
                                                                 throws IOException,
OpenSearchException

Retrieves all role mappings.

Throws:

IOException

OpenSearchException

getRoles

public CompletableFuture<GetRolesResponse> getRoles(GetRolesRequest request)
                                             throws IOException,
OpenSearchException

Retrieves all roles.

Throws:

IOException

OpenSearchException

getRoles

public final CompletableFuture<GetRolesResponse> getRoles(Function<GetRolesRequest.Builder,ObjectBuilder<GetRolesRequest>> fn)
                                                   throws IOException,
OpenSearchException

Retrieves all roles.

Parameters:

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

Throws:

IOException

OpenSearchException

getRoles

public final CompletableFuture<GetRolesResponse> getRoles()
                                                   throws IOException,
OpenSearchException

Retrieves all roles.

Throws:

IOException

OpenSearchException

getSslinfo

public CompletableFuture<GetSslinfoResponse> getSslinfo(GetSslinfoRequest request)
                                                 throws IOException,
OpenSearchException

Retrieves information about the SSL configuration.

Throws:

IOException

OpenSearchException

getSslinfo

public final CompletableFuture<GetSslinfoResponse> getSslinfo(Function<GetSslinfoRequest.Builder,ObjectBuilder<GetSslinfoRequest>> fn)
                                                       throws IOException,
OpenSearchException

Retrieves information about the SSL configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

getSslinfo

public final CompletableFuture<GetSslinfoResponse> getSslinfo()
                                                       throws IOException,
OpenSearchException

Retrieves information about the SSL configuration.

Throws:

IOException

OpenSearchException

getTenancyConfig

public CompletableFuture<GetTenancyConfigResponse> getTenancyConfig(GetTenancyConfigRequest request)
                                                             throws IOException,
OpenSearchException

Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

getTenancyConfig

public final CompletableFuture<GetTenancyConfigResponse> getTenancyConfig(Function<GetTenancyConfigRequest.Builder,ObjectBuilder<GetTenancyConfigRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

getTenancyConfig

public final CompletableFuture<GetTenancyConfigResponse> getTenancyConfig()
                                                                   throws IOException,
OpenSearchException

Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

getTenant

public CompletableFuture<GetTenantResponse> getTenant(GetTenantRequest request)
                                               throws IOException,
OpenSearchException

Retrieves the specified tenant.

Throws:

IOException

OpenSearchException

getTenant

public final CompletableFuture<GetTenantResponse> getTenant(Function<GetTenantRequest.Builder,ObjectBuilder<GetTenantRequest>> fn)
                                                     throws IOException,
OpenSearchException

Retrieves the specified tenant.

Parameters:

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

Throws:

IOException

OpenSearchException

getTenants

public CompletableFuture<GetTenantsResponse> getTenants(GetTenantsRequest request)
                                                 throws IOException,
OpenSearchException

Retrieves all tenants.

Throws:

IOException

OpenSearchException

getTenants

public final CompletableFuture<GetTenantsResponse> getTenants(Function<GetTenantsRequest.Builder,ObjectBuilder<GetTenantsRequest>> fn)
                                                       throws IOException,
OpenSearchException

Retrieves all tenants.

Parameters:

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

Throws:

IOException

OpenSearchException

getTenants

public final CompletableFuture<GetTenantsResponse> getTenants()
                                                       throws IOException,
OpenSearchException

Retrieves all tenants.

Throws:

IOException

OpenSearchException

getUser

public CompletableFuture<GetUserResponse> getUser(GetUserRequest request)
                                           throws IOException,
OpenSearchException

Retrieve information about the specified internal user.

Throws:

IOException

OpenSearchException

getUser

public final CompletableFuture<GetUserResponse> getUser(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)
                                                 throws IOException,
OpenSearchException

Retrieve information about the specified internal user.

Parameters:

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

Throws:

IOException

OpenSearchException

getUserLegacy

public CompletableFuture<GetUserLegacyResponse> getUserLegacy(GetUserLegacyRequest request)
                                                       throws IOException,
OpenSearchException

Retrieve one user. Legacy API.

Throws:

IOException

OpenSearchException

getUserLegacy

public final CompletableFuture<GetUserLegacyResponse> getUserLegacy(Function<GetUserLegacyRequest.Builder,ObjectBuilder<GetUserLegacyRequest>> fn)
                                                             throws IOException,
OpenSearchException

Retrieve one user. Legacy API.

Parameters:

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

Throws:

IOException

OpenSearchException

getUsers

public CompletableFuture<GetUsersResponse> getUsers(GetUsersRequest request)
                                             throws IOException,
OpenSearchException

Retrieve all internal users.

Throws:

IOException

OpenSearchException

getUsers

public final CompletableFuture<GetUsersResponse> getUsers(Function<GetUsersRequest.Builder,ObjectBuilder<GetUsersRequest>> fn)
                                                   throws IOException,
OpenSearchException

Retrieve all internal users.

Parameters:

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

Throws:

IOException

OpenSearchException

getUsers

public final CompletableFuture<GetUsersResponse> getUsers()
                                                   throws IOException,
OpenSearchException

Retrieve all internal users.

Throws:

IOException

OpenSearchException

getUsersLegacy

public CompletableFuture<GetUsersLegacyResponse> getUsersLegacy(GetUsersLegacyRequest request)
                                                         throws IOException,
OpenSearchException

Retrieve all internal users. Legacy API.

Throws:

IOException

OpenSearchException

getUsersLegacy

public final CompletableFuture<GetUsersLegacyResponse> getUsersLegacy(Function<GetUsersLegacyRequest.Builder,ObjectBuilder<GetUsersLegacyRequest>> fn)
                                                               throws IOException,
OpenSearchException

Retrieve all internal users. Legacy API.

Parameters:

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

Throws:

IOException

OpenSearchException

getUsersLegacy

public final CompletableFuture<GetUsersLegacyResponse> getUsersLegacy()
                                                               throws IOException,
OpenSearchException

Retrieve all internal users. Legacy API.

Throws:

IOException

OpenSearchException

health

public CompletableFuture<HealthResponse> health(HealthRequest request)
                                         throws IOException,
OpenSearchException

Checks to see if the Security plugin is running.

Throws:

IOException

OpenSearchException

health

public final CompletableFuture<HealthResponse> health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                                               throws IOException,
OpenSearchException

Checks to see if the Security plugin is running.

Parameters:

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

Throws:

IOException

OpenSearchException

health

public final CompletableFuture<HealthResponse> health()
                                               throws IOException,
OpenSearchException

Checks to see if the Security plugin is running.

Throws:

IOException

OpenSearchException

migrate

public CompletableFuture<MigrateResponse> migrate(MigrateRequest request)
                                           throws IOException,
OpenSearchException

Migrates the security configuration from v6 to v7.

Throws:

IOException

OpenSearchException

migrate

public final CompletableFuture<MigrateResponse> migrate(Function<MigrateRequest.Builder,ObjectBuilder<MigrateRequest>> fn)
                                                 throws IOException,
OpenSearchException

Migrates the security configuration from v6 to v7.

Parameters:

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

Throws:

IOException

OpenSearchException

migrate

public final CompletableFuture<MigrateResponse> migrate()
                                                 throws IOException,
OpenSearchException

Migrates the security configuration from v6 to v7.

Throws:

IOException

OpenSearchException

patchActionGroup

public CompletableFuture<PatchActionGroupResponse> patchActionGroup(PatchActionGroupRequest request)
                                                             throws IOException,
OpenSearchException

Updates the individual attributes of an action group.

Throws:

IOException

OpenSearchException

patchActionGroup

public final CompletableFuture<PatchActionGroupResponse> patchActionGroup(Function<PatchActionGroupRequest.Builder,ObjectBuilder<PatchActionGroupRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Updates the individual attributes of an action group.

Parameters:

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

Throws:

IOException

OpenSearchException

patchActionGroups

public CompletableFuture<PatchActionGroupsResponse> patchActionGroups(PatchActionGroupsRequest request)
                                                               throws IOException,
OpenSearchException

Creates, updates, or deletes multiple action groups in a single request.

Throws:

IOException

OpenSearchException

patchActionGroups

public final CompletableFuture<PatchActionGroupsResponse> patchActionGroups(Function<PatchActionGroupsRequest.Builder,ObjectBuilder<PatchActionGroupsRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Creates, updates, or deletes multiple action groups in a single request.

Parameters:

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

Throws:

IOException

OpenSearchException

patchAllowlist

public CompletableFuture<PatchAllowlistResponse> patchAllowlist(PatchAllowlistRequest request)
                                                         throws IOException,
OpenSearchException

Updates the current list of APIs accessible for users on the allow list.

Throws:

IOException

OpenSearchException

patchAllowlist

public final CompletableFuture<PatchAllowlistResponse> patchAllowlist(Function<PatchAllowlistRequest.Builder,ObjectBuilder<PatchAllowlistRequest>> fn)
                                                               throws IOException,
OpenSearchException

Updates the current list of APIs accessible for users on the allow list.

Parameters:

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

Throws:

IOException

OpenSearchException

patchAuditConfiguration

public CompletableFuture<PatchAuditConfigurationResponse> patchAuditConfiguration(PatchAuditConfigurationRequest request)
                                                                           throws IOException,
OpenSearchException

Updates the specified fields in the audit configuration.

Throws:

IOException

OpenSearchException

patchAuditConfiguration

public final CompletableFuture<PatchAuditConfigurationResponse> patchAuditConfiguration(Function<PatchAuditConfigurationRequest.Builder,ObjectBuilder<PatchAuditConfigurationRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Updates the specified fields in the audit configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

patchConfiguration

public CompletableFuture<PatchConfigurationResponse> patchConfiguration(PatchConfigurationRequest request)
                                                                 throws IOException,
OpenSearchException

Updates the existing security configuration using the REST API. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

patchConfiguration

public final CompletableFuture<PatchConfigurationResponse> patchConfiguration(Function<PatchConfigurationRequest.Builder,ObjectBuilder<PatchConfigurationRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Updates the existing security configuration using the REST API. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

patchDistinguishedName

public CompletableFuture<PatchDistinguishedNameResponse> patchDistinguishedName(PatchDistinguishedNameRequest request)
                                                                         throws IOException,
OpenSearchException

Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

patchDistinguishedName

public final CompletableFuture<PatchDistinguishedNameResponse> patchDistinguishedName(Function<PatchDistinguishedNameRequest.Builder,ObjectBuilder<PatchDistinguishedNameRequest>> fn)
                                                                               throws IOException,
OpenSearchException

Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

patchDistinguishedNames

public CompletableFuture<PatchDistinguishedNamesResponse> patchDistinguishedNames(PatchDistinguishedNamesRequest request)
                                                                           throws IOException,
OpenSearchException

Bulk updates specified node distinguished names. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

patchDistinguishedNames

public final CompletableFuture<PatchDistinguishedNamesResponse> patchDistinguishedNames(Function<PatchDistinguishedNamesRequest.Builder,ObjectBuilder<PatchDistinguishedNamesRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Bulk updates specified node distinguished names. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

patchRole

public CompletableFuture<PatchRoleResponse> patchRole(PatchRoleRequest request)
                                               throws IOException,
OpenSearchException

Updates the individual attributes of a role.

Throws:

IOException

OpenSearchException

patchRole

public final CompletableFuture<PatchRoleResponse> patchRole(Function<PatchRoleRequest.Builder,ObjectBuilder<PatchRoleRequest>> fn)
                                                     throws IOException,
OpenSearchException

Updates the individual attributes of a role.

Parameters:

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

Throws:

IOException

OpenSearchException

patchRoleMapping

public CompletableFuture<PatchRoleMappingResponse> patchRoleMapping(PatchRoleMappingRequest request)
                                                             throws IOException,
OpenSearchException

Updates the individual attributes of a role mapping.

Throws:

IOException

OpenSearchException

patchRoleMapping

public final CompletableFuture<PatchRoleMappingResponse> patchRoleMapping(Function<PatchRoleMappingRequest.Builder,ObjectBuilder<PatchRoleMappingRequest>> fn)
                                                                   throws IOException,
OpenSearchException

Updates the individual attributes of a role mapping.

Parameters:

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

Throws:

IOException

OpenSearchException

patchRoleMappings

public CompletableFuture<PatchRoleMappingsResponse> patchRoleMappings(PatchRoleMappingsRequest request)
                                                               throws IOException,
OpenSearchException

Creates or updates multiple role mappings in a single request.

Throws:

IOException

OpenSearchException

patchRoleMappings

public final CompletableFuture<PatchRoleMappingsResponse> patchRoleMappings(Function<PatchRoleMappingsRequest.Builder,ObjectBuilder<PatchRoleMappingsRequest>> fn)
                                                                     throws IOException,
OpenSearchException

Creates or updates multiple role mappings in a single request.

Parameters:

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

Throws:

IOException

OpenSearchException

patchRoles

public CompletableFuture<PatchRolesResponse> patchRoles(PatchRolesRequest request)
                                                 throws IOException,
OpenSearchException

Creates, updates, or deletes multiple roles in a single call.

Throws:

IOException

OpenSearchException

patchRoles

public final CompletableFuture<PatchRolesResponse> patchRoles(Function<PatchRolesRequest.Builder,ObjectBuilder<PatchRolesRequest>> fn)
                                                       throws IOException,
OpenSearchException

Creates, updates, or deletes multiple roles in a single call.

Parameters:

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

Throws:

IOException

OpenSearchException

patchTenant

public CompletableFuture<PatchTenantResponse> patchTenant(PatchTenantRequest request)
                                                   throws IOException,
OpenSearchException

Adds, deletes, or modifies a single tenant.

Throws:

IOException

OpenSearchException

patchTenant

public final CompletableFuture<PatchTenantResponse> patchTenant(Function<PatchTenantRequest.Builder,ObjectBuilder<PatchTenantRequest>> fn)
                                                         throws IOException,
OpenSearchException

Adds, deletes, or modifies a single tenant.

Parameters:

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

Throws:

IOException

OpenSearchException

patchTenants

public CompletableFuture<PatchTenantsResponse> patchTenants(PatchTenantsRequest request)
                                                     throws IOException,
OpenSearchException

Adds, deletes, or modifies multiple tenants in a single request.

Throws:

IOException

OpenSearchException

patchTenants

public final CompletableFuture<PatchTenantsResponse> patchTenants(Function<PatchTenantsRequest.Builder,ObjectBuilder<PatchTenantsRequest>> fn)
                                                           throws IOException,
OpenSearchException

Adds, deletes, or modifies multiple tenants in a single request.

Parameters:

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

Throws:

IOException

OpenSearchException

patchUser

public CompletableFuture<PatchUserResponse> patchUser(PatchUserRequest request)
                                               throws IOException,
OpenSearchException

Updates individual attributes for an internal user.

Throws:

IOException

OpenSearchException

patchUser

public final CompletableFuture<PatchUserResponse> patchUser(Function<PatchUserRequest.Builder,ObjectBuilder<PatchUserRequest>> fn)
                                                     throws IOException,
OpenSearchException

Updates individual attributes for an internal user.

Parameters:

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

Throws:

IOException

OpenSearchException

patchUsers

public CompletableFuture<PatchUsersResponse> patchUsers(PatchUsersRequest request)
                                                 throws IOException,
OpenSearchException

Creates, updates, or deletes multiple internal users in a single request.

Throws:

IOException

OpenSearchException

patchUsers

public final CompletableFuture<PatchUsersResponse> patchUsers(Function<PatchUsersRequest.Builder,ObjectBuilder<PatchUsersRequest>> fn)
                                                       throws IOException,
OpenSearchException

Creates, updates, or deletes multiple internal users in a single request.

Parameters:

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

Throws:

IOException

OpenSearchException

postDashboardsInfo

public CompletableFuture<PostDashboardsInfoResponse> postDashboardsInfo(PostDashboardsInfoRequest request)
                                                                 throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Throws:

IOException

OpenSearchException

postDashboardsInfo

public final CompletableFuture<PostDashboardsInfoResponse> postDashboardsInfo(Function<PostDashboardsInfoRequest.Builder,ObjectBuilder<PostDashboardsInfoRequest>> fn)
                                                                       throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Parameters:

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

Throws:

IOException

OpenSearchException

postDashboardsInfo

public final CompletableFuture<PostDashboardsInfoResponse> postDashboardsInfo()
                                                                       throws IOException,
OpenSearchException

Retrieves the current values for dynamic security settings for OpenSearch Dashboards.

Throws:

IOException

OpenSearchException

reloadHttpCertificates

public CompletableFuture<ReloadHttpCertificatesResponse> reloadHttpCertificates(ReloadHttpCertificatesRequest request)
                                                                         throws IOException,
OpenSearchException

Reloads the HTTP communication certificates.

Throws:

IOException

OpenSearchException

reloadHttpCertificates

public final CompletableFuture<ReloadHttpCertificatesResponse> reloadHttpCertificates(Function<ReloadHttpCertificatesRequest.Builder,ObjectBuilder<ReloadHttpCertificatesRequest>> fn)
                                                                               throws IOException,
OpenSearchException

Reloads the HTTP communication certificates.

Parameters:

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

Throws:

IOException

OpenSearchException

reloadHttpCertificates

public final CompletableFuture<ReloadHttpCertificatesResponse> reloadHttpCertificates()
                                                                               throws IOException,
OpenSearchException

Reloads the HTTP communication certificates.

Throws:

IOException

OpenSearchException

reloadTransportCertificates

public CompletableFuture<ReloadTransportCertificatesResponse> reloadTransportCertificates(ReloadTransportCertificatesRequest request)
                                                                                   throws IOException,
OpenSearchException

Reloads the transport communication certificates.

Throws:

IOException

OpenSearchException

reloadTransportCertificates

public final CompletableFuture<ReloadTransportCertificatesResponse> reloadTransportCertificates(Function<ReloadTransportCertificatesRequest.Builder,ObjectBuilder<ReloadTransportCertificatesRequest>> fn)
                                                                                         throws IOException,
OpenSearchException

Reloads the transport communication certificates.

Parameters:

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

Throws:

IOException

OpenSearchException

reloadTransportCertificates

public final CompletableFuture<ReloadTransportCertificatesResponse> reloadTransportCertificates()
                                                                                         throws IOException,
OpenSearchException

Reloads the transport communication certificates.

Throws:

IOException

OpenSearchException

tenantInfo

public CompletableFuture<TenantInfoResponse> tenantInfo(TenantInfoRequest request)
                                                 throws IOException,
OpenSearchException

Retrieves the names of current tenants. Requires super admin or kibanaserver permissions.

Throws:

IOException

OpenSearchException

tenantInfo

public final CompletableFuture<TenantInfoResponse> tenantInfo(Function<TenantInfoRequest.Builder,ObjectBuilder<TenantInfoRequest>> fn)
                                                       throws IOException,
OpenSearchException

Retrieves the names of current tenants. Requires super admin or kibanaserver permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

tenantInfo

public final CompletableFuture<TenantInfoResponse> tenantInfo()
                                                       throws IOException,
OpenSearchException

Retrieves the names of current tenants. Requires super admin or kibanaserver permissions.

Throws:

IOException

OpenSearchException

updateAuditConfiguration

public CompletableFuture<UpdateAuditConfigurationResponse> updateAuditConfiguration(UpdateAuditConfigurationRequest request)
                                                                             throws IOException,
OpenSearchException

Updates the audit configuration.

Throws:

IOException

OpenSearchException

updateAuditConfiguration

public final CompletableFuture<UpdateAuditConfigurationResponse> updateAuditConfiguration(Function<UpdateAuditConfigurationRequest.Builder,ObjectBuilder<UpdateAuditConfigurationRequest>> fn)
                                                                                   throws IOException,
OpenSearchException

Updates the audit configuration.

Parameters:

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

Throws:

IOException

OpenSearchException

updateAuditConfiguration

public final CompletableFuture<UpdateAuditConfigurationResponse> updateAuditConfiguration()
                                                                                   throws IOException,
OpenSearchException

Updates the audit configuration.

Throws:

IOException

OpenSearchException

updateConfiguration

public CompletableFuture<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest request)
                                                                   throws IOException,
OpenSearchException

Updates the settings for an existing security configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

updateConfiguration

public final CompletableFuture<UpdateConfigurationResponse> updateConfiguration(Function<UpdateConfigurationRequest.Builder,ObjectBuilder<UpdateConfigurationRequest>> fn)
                                                                         throws IOException,
OpenSearchException

Updates the settings for an existing security configuration. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

updateConfiguration

public final CompletableFuture<UpdateConfigurationResponse> updateConfiguration()
                                                                         throws IOException,
OpenSearchException

Updates the settings for an existing security configuration. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

updateDistinguishedName

public CompletableFuture<UpdateDistinguishedNameResponse> updateDistinguishedName(UpdateDistinguishedNameRequest request)
                                                                           throws IOException,
OpenSearchException

Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions.

Throws:

IOException

OpenSearchException

updateDistinguishedName

public final CompletableFuture<UpdateDistinguishedNameResponse> updateDistinguishedName(Function<UpdateDistinguishedNameRequest.Builder,ObjectBuilder<UpdateDistinguishedNameRequest>> fn)
                                                                                 throws IOException,
OpenSearchException

Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions.

Parameters:

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

Throws:

IOException

OpenSearchException

validate

public CompletableFuture<ValidateResponse> validate(ValidateRequest request)
                                             throws IOException,
OpenSearchException

Checks whether the v6 security configuration is valid and ready to be migrated to v7.

Throws:

IOException

OpenSearchException

validate

public final CompletableFuture<ValidateResponse> validate(Function<ValidateRequest.Builder,ObjectBuilder<ValidateRequest>> fn)
                                                   throws IOException,
OpenSearchException

Checks whether the v6 security configuration is valid and ready to be migrated to v7.

Parameters:

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

Throws:

IOException

OpenSearchException

validate

public final CompletableFuture<ValidateResponse> validate()
                                                   throws IOException,
OpenSearchException

Checks whether the v6 security configuration is valid and ready to be migrated to v7.

Throws:

IOException

OpenSearchException

whoAmI

public CompletableFuture<WhoAmIResponse> whoAmI(WhoAmIRequest request)
                                         throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in.

Throws:

IOException

OpenSearchException

whoAmI

public final CompletableFuture<WhoAmIResponse> whoAmI(Function<WhoAmIRequest.Builder,ObjectBuilder<WhoAmIRequest>> fn)
                                               throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in.

Parameters:

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

Throws:

IOException

OpenSearchException

whoAmI

public final CompletableFuture<WhoAmIResponse> whoAmI()
                                               throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in.

Throws:

IOException

OpenSearchException

whoAmIProtected

public CompletableFuture<WhoAmIProtectedResponse> whoAmIProtected(WhoAmIProtectedRequest request)
                                                           throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.

Throws:

IOException

OpenSearchException

whoAmIProtected

public final CompletableFuture<WhoAmIProtectedResponse> whoAmIProtected(Function<WhoAmIProtectedRequest.Builder,ObjectBuilder<WhoAmIProtectedRequest>> fn)
                                                                 throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.

Parameters:

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

Throws:

IOException

OpenSearchException

whoAmIProtected

public final CompletableFuture<WhoAmIProtectedResponse> whoAmIProtected()
                                                                 throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.

Throws:

IOException

OpenSearchException