Package org.opensearch.client.opensearch.security

Class OpenSearchSecurityClient

java.lang.Object

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

org.opensearch.client.opensearch.security.OpenSearchSecurityClient

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

Client for the security namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchSecurityClient

public OpenSearchSecurityClient(OpenSearchTransport transport)

OpenSearchSecurityClient

public OpenSearchSecurityClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSecurityClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSecurityClient>

authinfo

public AuthinfoResponse authinfo(AuthinfoRequest request)
                          throws IOException,
OpenSearchException

Returns or updates authentication information for the currently authenticated user.

Throws:

IOException

OpenSearchException

authinfo

public final 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 AuthinfoResponse authinfo()
                                throws IOException,
OpenSearchException

Returns or updates authentication information for the currently authenticated user.

Throws:

IOException

OpenSearchException

authtoken

public AuthtokenResponse authtoken(AuthtokenRequest request)
                            throws IOException,
OpenSearchException

Returns the authorization token for the current user.

Throws:

IOException

OpenSearchException

authtoken

public final 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 AuthtokenResponse authtoken()
                                  throws IOException,
OpenSearchException

Returns the authorization token for the current user.

Throws:

IOException

OpenSearchException

changePassword

public ChangePasswordResponse changePassword(ChangePasswordRequest request)
                                      throws IOException,
OpenSearchException

Changes the password for the current user.

Throws:

IOException

OpenSearchException

changePassword

public final 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 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 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 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 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 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 ConfigUpgradePerformResponse configUpgradePerform()
                                                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

createActionGroup

public CreateActionGroupResponse createActionGroup(CreateActionGroupRequest request)
                                            throws IOException,
OpenSearchException

Creates or replaces the specified action group.

Throws:

IOException

OpenSearchException

createActionGroup

public final 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 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 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 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 CreateRoleResponse createRole(CreateRoleRequest request)
                              throws IOException,
OpenSearchException

Creates or replaces the specified role.

Throws:

IOException

OpenSearchException

createRole

public final 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 CreateRoleMappingResponse createRoleMapping(CreateRoleMappingRequest request)
                                            throws IOException,
OpenSearchException

Creates or replaces the specified role mapping.

Throws:

IOException

OpenSearchException

createRoleMapping

public final 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 CreateTenantResponse createTenant(CreateTenantRequest request)
                                  throws IOException,
OpenSearchException

Creates or replaces the specified tenant.

Throws:

IOException

OpenSearchException

createTenant

public final 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 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 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 CreateUpdateTenancyConfigResponse createUpdateTenancyConfig()
                                                                  throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

createUser

public CreateUserResponse createUser(CreateUserRequest request)
                              throws IOException,
OpenSearchException

Creates or replaces the specified user.

Throws:

IOException

OpenSearchException

createUser

public final 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 CreateUserLegacyResponse createUserLegacy(CreateUserLegacyRequest request)
                                          throws IOException,
OpenSearchException

Creates or replaces the specified user. Legacy API.

Throws:

IOException

OpenSearchException

createUserLegacy

public final 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 DeleteActionGroupResponse deleteActionGroup(DeleteActionGroupRequest request)
                                            throws IOException,
OpenSearchException

Deletes the specified action group.

Throws:

IOException

OpenSearchException

deleteActionGroup

public final 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 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 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 DeleteRoleResponse deleteRole(DeleteRoleRequest request)
                              throws IOException,
OpenSearchException

Deletes the specified role.

Throws:

IOException

OpenSearchException

deleteRole

public final 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 DeleteRoleMappingResponse deleteRoleMapping(DeleteRoleMappingRequest request)
                                            throws IOException,
OpenSearchException

Deletes the specified role mapping.

Throws:

IOException

OpenSearchException

deleteRoleMapping

public final 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 DeleteTenantResponse deleteTenant(DeleteTenantRequest request)
                                  throws IOException,
OpenSearchException

Deletes the specified tenant.

Throws:

IOException

OpenSearchException

deleteTenant

public final 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 DeleteUserResponse deleteUser(DeleteUserRequest request)
                              throws IOException,
OpenSearchException

Deletes the specified internal user.

Throws:

IOException

OpenSearchException

deleteUser

public final 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 DeleteUserLegacyResponse deleteUserLegacy(DeleteUserLegacyRequest request)
                                          throws IOException,
OpenSearchException

Delete the specified user. Legacy API.

Throws:

IOException

OpenSearchException

deleteUserLegacy

public final 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 FlushCacheResponse flushCache(FlushCacheRequest request)
                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

flushCache

public final 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 FlushCacheResponse flushCache()
                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

generateOboToken

public GenerateOboTokenResponse generateOboToken(GenerateOboTokenRequest request)
                                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

generateOboToken

public final 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 GenerateUserTokenResponse generateUserToken(GenerateUserTokenRequest request)
                                            throws IOException,
OpenSearchException

Generates an authorization token for the specified user.

Throws:

IOException

OpenSearchException

generateUserToken

public final 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 BooleanResponse generateUserTokenLegacy(GenerateUserTokenLegacyRequest request)
                                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

generateUserTokenLegacy

public final 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 GetAccountDetailsResponse getAccountDetails(GetAccountDetailsRequest request)
                                            throws IOException,
OpenSearchException

Returns account information for the current user.

Throws:

IOException

OpenSearchException

getAccountDetails

public final 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 GetAccountDetailsResponse getAccountDetails()
                                                  throws IOException,
OpenSearchException

Returns account information for the current user.

Throws:

IOException

OpenSearchException

getActionGroup

public GetActionGroupResponse getActionGroup(GetActionGroupRequest request)
                                      throws IOException,
OpenSearchException

Retrieves one action group.

Throws:

IOException

OpenSearchException

getActionGroup

public final 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 GetActionGroupsResponse getActionGroups(GetActionGroupsRequest request)
                                        throws IOException,
OpenSearchException

Retrieves all action groups.

Throws:

IOException

OpenSearchException

getActionGroups

public final 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 GetActionGroupsResponse getActionGroups()
                                              throws IOException,
OpenSearchException

Retrieves all action groups.

Throws:

IOException

OpenSearchException

getAllCertificates

public GetAllCertificatesResponse getAllCertificates(GetAllCertificatesRequest request)
                                              throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getAllCertificates

public final 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 GetAllCertificatesResponse getAllCertificates()
                                                    throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getAllowlist

public 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 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 GetAllowlistResponse getAllowlist()
                                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getAuditConfiguration

public GetAuditConfigurationResponse getAuditConfiguration(GetAuditConfigurationRequest request)
                                                    throws IOException,
OpenSearchException

Retrieves the audit configuration.

Throws:

IOException

OpenSearchException

getAuditConfiguration

public final 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 GetAuditConfigurationResponse getAuditConfiguration()
                                                          throws IOException,
OpenSearchException

Retrieves the audit configuration.

Throws:

IOException

OpenSearchException

getCertificates

public GetCertificatesResponse getCertificates(GetCertificatesRequest request)
                                        throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getCertificates

public final 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 GetCertificatesResponse getCertificates()
                                              throws IOException,
OpenSearchException

Retrieves the cluster security certificates.

Throws:

IOException

OpenSearchException

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
                                          throws IOException,
OpenSearchException

Returns the current Security plugin configuration in a JSON format.

Throws:

IOException

OpenSearchException

getConfiguration

public final 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 GetConfigurationResponse getConfiguration()
                                                throws IOException,
OpenSearchException

Returns the current Security plugin configuration in a JSON format.

Throws:

IOException

OpenSearchException

getDashboardsInfo

public GetDashboardsInfoResponse getDashboardsInfo(GetDashboardsInfoRequest request)
                                            throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getDashboardsInfo

public final 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 GetDashboardsInfoResponse getDashboardsInfo()
                                                  throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getDistinguishedName

public 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 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 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 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 GetDistinguishedNamesResponse getDistinguishedNames()
                                                          throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getNodeCertificates

public GetNodeCertificatesResponse getNodeCertificates(GetNodeCertificatesRequest request)
                                                throws IOException,
OpenSearchException

Retrieves the specified node's security certificates.

Throws:

IOException

OpenSearchException

getNodeCertificates

public final 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 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 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 GetPermissionsInfoResponse getPermissionsInfo()
                                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getRole

public GetRoleResponse getRole(GetRoleRequest request)
                        throws IOException,
OpenSearchException

Retrieves one role.

Throws:

IOException

OpenSearchException

getRole

public final 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 GetRoleMappingResponse getRoleMapping(GetRoleMappingRequest request)
                                      throws IOException,
OpenSearchException

Retrieves the specified role mapping.

Throws:

IOException

OpenSearchException

getRoleMapping

public final 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 GetRoleMappingsResponse getRoleMappings(GetRoleMappingsRequest request)
                                        throws IOException,
OpenSearchException

Retrieves all role mappings.

Throws:

IOException

OpenSearchException

getRoleMappings

public final 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 GetRoleMappingsResponse getRoleMappings()
                                              throws IOException,
OpenSearchException

Retrieves all role mappings.

Throws:

IOException

OpenSearchException

getRoles

public GetRolesResponse getRoles(GetRolesRequest request)
                          throws IOException,
OpenSearchException

Retrieves all roles.

Throws:

IOException

OpenSearchException

getRoles

public final 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 GetRolesResponse getRoles()
                                throws IOException,
OpenSearchException

Retrieves all roles.

Throws:

IOException

OpenSearchException

getSslinfo

public GetSslinfoResponse getSslinfo(GetSslinfoRequest request)
                              throws IOException,
OpenSearchException

Retrieves information about the SSL configuration.

Throws:

IOException

OpenSearchException

getSslinfo

public final 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 GetSslinfoResponse getSslinfo()
                                    throws IOException,
OpenSearchException

Retrieves information about the SSL configuration.

Throws:

IOException

OpenSearchException

getTenancyConfig

public 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 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 GetTenancyConfigResponse getTenancyConfig()
                                                throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

getTenant

public GetTenantResponse getTenant(GetTenantRequest request)
                            throws IOException,
OpenSearchException

Retrieves the specified tenant.

Throws:

IOException

OpenSearchException

getTenant

public final 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 GetTenantsResponse getTenants(GetTenantsRequest request)
                              throws IOException,
OpenSearchException

Retrieves all tenants.

Throws:

IOException

OpenSearchException

getTenants

public final 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 GetTenantsResponse getTenants()
                                    throws IOException,
OpenSearchException

Retrieves all tenants.

Throws:

IOException

OpenSearchException

getUser

public GetUserResponse getUser(GetUserRequest request)
                        throws IOException,
OpenSearchException

Retrieve information about the specified internal user.

Throws:

IOException

OpenSearchException

getUser

public final 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 GetUserLegacyResponse getUserLegacy(GetUserLegacyRequest request)
                                    throws IOException,
OpenSearchException

Retrieve one user. Legacy API.

Throws:

IOException

OpenSearchException

getUserLegacy

public final 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 GetUsersResponse getUsers(GetUsersRequest request)
                          throws IOException,
OpenSearchException

Retrieve all internal users.

Throws:

IOException

OpenSearchException

getUsers

public final 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 GetUsersResponse getUsers()
                                throws IOException,
OpenSearchException

Retrieve all internal users.

Throws:

IOException

OpenSearchException

getUsersLegacy

public GetUsersLegacyResponse getUsersLegacy(GetUsersLegacyRequest request)
                                      throws IOException,
OpenSearchException

Retrieve all internal users. Legacy API.

Throws:

IOException

OpenSearchException

getUsersLegacy

public final 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 GetUsersLegacyResponse getUsersLegacy()
                                            throws IOException,
OpenSearchException

Retrieve all internal users. Legacy API.

Throws:

IOException

OpenSearchException

health

public HealthResponse health(HealthRequest request)
                      throws IOException,
OpenSearchException

Checks to see if the Security plugin is running.

Throws:

IOException

OpenSearchException

health

public final 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 HealthResponse health()
                            throws IOException,
OpenSearchException

Checks to see if the Security plugin is running.

Throws:

IOException

OpenSearchException

migrate

public MigrateResponse migrate(MigrateRequest request)
                        throws IOException,
OpenSearchException

Migrates the security configuration from v6 to v7.

Throws:

IOException

OpenSearchException

migrate

public final 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 MigrateResponse migrate()
                              throws IOException,
OpenSearchException

Migrates the security configuration from v6 to v7.

Throws:

IOException

OpenSearchException

patchActionGroup

public PatchActionGroupResponse patchActionGroup(PatchActionGroupRequest request)
                                          throws IOException,
OpenSearchException

Updates the individual attributes of an action group.

Throws:

IOException

OpenSearchException

patchActionGroup

public final 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 PatchActionGroupsResponse patchActionGroups(PatchActionGroupsRequest request)
                                            throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

patchActionGroups

public final 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 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 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 PatchAuditConfigurationResponse patchAuditConfiguration(PatchAuditConfigurationRequest request)
                                                        throws IOException,
OpenSearchException

Updates the specified fields in the audit configuration.

Throws:

IOException

OpenSearchException

patchAuditConfiguration

public final 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 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 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 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 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 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 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 PatchRoleResponse patchRole(PatchRoleRequest request)
                            throws IOException,
OpenSearchException

Updates the individual attributes of a role.

Throws:

IOException

OpenSearchException

patchRole

public final 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 PatchRoleMappingResponse patchRoleMapping(PatchRoleMappingRequest request)
                                          throws IOException,
OpenSearchException

Updates the individual attributes of a role mapping.

Throws:

IOException

OpenSearchException

patchRoleMapping

public final 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 PatchRoleMappingsResponse patchRoleMappings(PatchRoleMappingsRequest request)
                                            throws IOException,
OpenSearchException

Creates or updates multiple role mappings in a single request.

Throws:

IOException

OpenSearchException

patchRoleMappings

public final 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 PatchRolesResponse patchRoles(PatchRolesRequest request)
                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

patchRoles

public final 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 PatchTenantResponse patchTenant(PatchTenantRequest request)
                                throws IOException,
OpenSearchException

Adds, deletes, or modifies a single tenant.

Throws:

IOException

OpenSearchException

patchTenant

public final 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 PatchTenantsResponse patchTenants(PatchTenantsRequest request)
                                  throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

patchTenants

public final 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 PatchUserResponse patchUser(PatchUserRequest request)
                            throws IOException,
OpenSearchException

Updates individual attributes for an internal user.

Throws:

IOException

OpenSearchException

patchUser

public final 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 PatchUsersResponse patchUsers(PatchUsersRequest request)
                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

patchUsers

public final 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 PostDashboardsInfoResponse postDashboardsInfo(PostDashboardsInfoRequest request)
                                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

postDashboardsInfo

public final 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 PostDashboardsInfoResponse postDashboardsInfo()
                                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

reloadHttpCertificates

public ReloadHttpCertificatesResponse reloadHttpCertificates(ReloadHttpCertificatesRequest request)
                                                      throws IOException,
OpenSearchException

Reloads the HTTP communication certificates.

Throws:

IOException

OpenSearchException

reloadHttpCertificates

public final 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 ReloadHttpCertificatesResponse reloadHttpCertificates()
                                                            throws IOException,
OpenSearchException

Reloads the HTTP communication certificates.

Throws:

IOException

OpenSearchException

reloadTransportCertificates

public ReloadTransportCertificatesResponse reloadTransportCertificates(ReloadTransportCertificatesRequest request)
                                                                throws IOException,
OpenSearchException

Reloads the transport communication certificates.

Throws:

IOException

OpenSearchException

reloadTransportCertificates

public final 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 ReloadTransportCertificatesResponse reloadTransportCertificates()
                                                                      throws IOException,
OpenSearchException

Reloads the transport communication certificates.

Throws:

IOException

OpenSearchException

tenantInfo

public 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 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 TenantInfoResponse tenantInfo()
                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

updateAuditConfiguration

public UpdateAuditConfigurationResponse updateAuditConfiguration(UpdateAuditConfigurationRequest request)
                                                          throws IOException,
OpenSearchException

Updates the audit configuration.

Throws:

IOException

OpenSearchException

updateAuditConfiguration

public final 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 UpdateAuditConfigurationResponse updateAuditConfiguration()
                                                                throws IOException,
OpenSearchException

Updates the audit configuration.

Throws:

IOException

OpenSearchException

updateConfiguration

public 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 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 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 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 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 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 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 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 WhoAmIResponse whoAmI(WhoAmIRequest request)
                      throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in.

Throws:

IOException

OpenSearchException

whoAmI

public final 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 WhoAmIResponse whoAmI()
                            throws IOException,
OpenSearchException

Gets the identity information for the user currently logged in.

Throws:

IOException

OpenSearchException

whoAmIProtected

public 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 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 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