Package org.opensearch.client.opensearch.security

package org.opensearch.client.opensearch.security

Related Packages

Package	Description
org.opensearch.client.opensearch

Classes

Class	Description
ActionGroup
ActionGroup.Builder	Builder for ActionGroup.
AuditConfig
AuditConfig.Builder	Builder for AuditConfig.
AuditLogsConfig
AuditLogsConfig.Builder	Builder for AuditLogsConfig.
AuthinfoRequest	Returns or updates authentication information for the currently authenticated user.
AuthinfoRequest.Builder	Builder for AuthinfoRequest.
AuthinfoResponse
AuthinfoResponse.Builder	Builder for AuthinfoResponse.
AuthtokenRequest	Returns the authorization token for the current user.
AuthtokenRequest.Builder	Builder for AuthtokenRequest.
AuthtokenResponse
AuthtokenResponse.Builder	Builder for AuthtokenResponse.
CertificatesDetail
CertificatesDetail.Builder	Builder for CertificatesDetail.
CertificatesPerNode
CertificatesPerNode.Builder	Builder for CertificatesPerNode.
CertificateTypes
CertificateTypes.Builder	Builder for CertificateTypes.
ChangePasswordRequest	Changes the password for the current user.
ChangePasswordRequest.Builder	Builder for ChangePasswordRequest.
ChangePasswordResponse
ChangePasswordResponse.Builder	Builder for ChangePasswordResponse.
ComplianceConfig
ComplianceConfig.Builder	Builder for ComplianceConfig.
ConfigUpgradeCheckRequest	Checks whether or not an upgrade can be performed and which security resources can be updated.
ConfigUpgradeCheckRequest.Builder	Builder for ConfigUpgradeCheckRequest.
ConfigUpgradeCheckResponse
ConfigUpgradeCheckResponse.Builder	Builder for ConfigUpgradeCheckResponse.
ConfigUpgradePerformRequest	Assists the cluster operator with upgrading missing default values and stale default definitions.
ConfigUpgradePerformRequest.Builder	Builder for ConfigUpgradePerformRequest.
ConfigUpgradePerformResponse
ConfigUpgradePerformResponse.Builder	Builder for ConfigUpgradePerformResponse.
CreateActionGroupRequest	Creates or replaces the specified action group.
CreateActionGroupRequest.Builder	Builder for CreateActionGroupRequest.
CreateActionGroupResponse
CreateActionGroupResponse.Builder	Builder for CreateActionGroupResponse.
CreateAllowlistRequest	Creates or replaces APIs permitted for users on the allow list.
CreateAllowlistRequest.Builder	Builder for CreateAllowlistRequest.
CreateAllowlistResponse
CreateAllowlistResponse.Builder	Builder for CreateAllowlistResponse.
CreateRoleMappingRequest	Creates or replaces the specified role mapping.
CreateRoleMappingRequest.Builder	Builder for CreateRoleMappingRequest.
CreateRoleMappingResponse
CreateRoleMappingResponse.Builder	Builder for CreateRoleMappingResponse.
CreateRoleRequest	Creates or replaces the specified role.
CreateRoleRequest.Builder	Builder for CreateRoleRequest.
CreateRoleResponse
CreateRoleResponse.Builder	Builder for CreateRoleResponse.
CreateTenantRequest	Creates or replaces the specified tenant.
CreateTenantRequest.Builder	Builder for CreateTenantRequest.
CreateTenantResponse
CreateTenantResponse.Builder	Builder for CreateTenantResponse.
CreateUpdateTenancyConfigRequest	Creates or replaces the multi-tenancy configuration.
CreateUpdateTenancyConfigRequest.Builder	Builder for CreateUpdateTenancyConfigRequest.
CreateUpdateTenancyConfigResponse
CreateUpdateTenancyConfigResponse.Builder	Builder for CreateUpdateTenancyConfigResponse.
CreateUserLegacyRequest	Creates or replaces the specified user.
CreateUserLegacyRequest.Builder	Builder for CreateUserLegacyRequest.
CreateUserLegacyResponse
CreateUserLegacyResponse.Builder	Builder for CreateUserLegacyResponse.
CreateUserRequest	Creates or replaces the specified user.
CreateUserRequest.Builder	Builder for CreateUserRequest.
CreateUserResponse
CreateUserResponse.Builder	Builder for CreateUserResponse.
DeleteActionGroupRequest	Deletes the specified action group.
DeleteActionGroupRequest.Builder	Builder for DeleteActionGroupRequest.
DeleteActionGroupResponse
DeleteActionGroupResponse.Builder	Builder for DeleteActionGroupResponse.
DeleteDistinguishedNameRequest	Deletes all distinguished names in the specified cluster or node allowlist.
DeleteDistinguishedNameRequest.Builder	Builder for DeleteDistinguishedNameRequest.
DeleteDistinguishedNameResponse
DeleteDistinguishedNameResponse.Builder	Builder for DeleteDistinguishedNameResponse.
DeleteRoleMappingRequest	Deletes the specified role mapping.
DeleteRoleMappingRequest.Builder	Builder for DeleteRoleMappingRequest.
DeleteRoleMappingResponse
DeleteRoleMappingResponse.Builder	Builder for DeleteRoleMappingResponse.
DeleteRoleRequest	Deletes the specified role.
DeleteRoleRequest.Builder	Builder for DeleteRoleRequest.
DeleteRoleResponse
DeleteRoleResponse.Builder	Builder for DeleteRoleResponse.
DeleteTenantRequest	Deletes the specified tenant.
DeleteTenantRequest.Builder	Builder for DeleteTenantRequest.
DeleteTenantResponse
DeleteTenantResponse.Builder	Builder for DeleteTenantResponse.
DeleteUserLegacyRequest	Delete the specified user.
DeleteUserLegacyRequest.Builder	Builder for DeleteUserLegacyRequest.
DeleteUserLegacyResponse
DeleteUserLegacyResponse.Builder	Builder for DeleteUserLegacyResponse.
DeleteUserRequest	Deletes the specified internal user.
DeleteUserRequest.Builder	Builder for DeleteUserRequest.
DeleteUserResponse
DeleteUserResponse.Builder	Builder for DeleteUserResponse.
DistinguishedNames
DistinguishedNames.Builder	Builder for DistinguishedNames.
DynamicConfig
DynamicConfig.Builder	Builder for DynamicConfig.
DynamicOptions
DynamicOptions.Builder	Builder for DynamicOptions.
FlushCacheRequest	Flushes the Security plugin's user, authentication, and authorization cache.
FlushCacheRequest.Builder	Builder for FlushCacheRequest.
FlushCacheResponse
FlushCacheResponse.Builder	Builder for FlushCacheResponse.
GenerateOboTokenRequest	Generates a On-Behalf-Of token for the current user.
GenerateOboTokenRequest.Builder	Builder for GenerateOboTokenRequest.
GenerateOboTokenResponse
GenerateOboTokenResponse.Builder	Builder for GenerateOboTokenResponse.
GenerateUserTokenLegacyRequest	Generates authorization token for the given user.
GenerateUserTokenLegacyRequest.Builder	Builder for GenerateUserTokenLegacyRequest.
GenerateUserTokenRequest	Generates an authorization token for the specified user.
GenerateUserTokenRequest.Builder	Builder for GenerateUserTokenRequest.
GenerateUserTokenResponse
GenerateUserTokenResponse.Builder	Builder for GenerateUserTokenResponse.
GetAccountDetailsRequest	Returns account information for the current user.
GetAccountDetailsRequest.Builder	Builder for GetAccountDetailsRequest.
GetAccountDetailsResponse
GetAccountDetailsResponse.Builder	Builder for GetAccountDetailsResponse.
GetActionGroupRequest	Retrieves one action group.
GetActionGroupRequest.Builder	Builder for GetActionGroupRequest.
GetActionGroupResponse
GetActionGroupResponse.Builder	Builder for GetActionGroupResponse.
GetActionGroupsRequest	Retrieves all action groups.
GetActionGroupsRequest.Builder	Builder for GetActionGroupsRequest.
GetActionGroupsResponse
GetActionGroupsResponse.Builder	Builder for GetActionGroupsResponse.
GetAllCertificatesRequest	Retrieves the cluster security certificates.
GetAllCertificatesRequest.Builder	Builder for GetAllCertificatesRequest.
GetAllCertificatesResponse
GetAllCertificatesResponse.Builder	Builder for GetAllCertificatesResponse.
GetAllowlistRequest	Retrieves the current list of allowed APIs accessible to a normal user.
GetAllowlistRequest.Builder	Builder for GetAllowlistRequest.
GetAllowlistResponse
GetAllowlistResponse.Builder	Builder for GetAllowlistResponse.
GetAuditConfigurationRequest	Retrieves the audit configuration.
GetAuditConfigurationRequest.Builder	Builder for GetAuditConfigurationRequest.
GetAuditConfigurationResponse
GetAuditConfigurationResponse.Builder	Builder for GetAuditConfigurationResponse.
GetCertificatesRequest	Retrieves the cluster security certificates.
GetCertificatesRequest.Builder	Builder for GetCertificatesRequest.
GetCertificatesResponse
GetCertificatesResponse.Builder	Builder for GetCertificatesResponse.
GetConfigurationRequest	Returns the current Security plugin configuration in a JSON format.
GetConfigurationRequest.Builder	Builder for GetConfigurationRequest.
GetConfigurationResponse
GetConfigurationResponse.Builder	Builder for GetConfigurationResponse.
GetDashboardsInfoRequest	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
GetDashboardsInfoRequest.Builder	Builder for GetDashboardsInfoRequest.
GetDashboardsInfoResponse
GetDashboardsInfoResponse.Builder	Builder for GetDashboardsInfoResponse.
GetDistinguishedNameRequest	Retrieves all node distinguished names.
GetDistinguishedNameRequest.Builder	Builder for GetDistinguishedNameRequest.
GetDistinguishedNameResponse
GetDistinguishedNameResponse.Builder	Builder for GetDistinguishedNameResponse.
GetDistinguishedNamesRequest	Retrieves all node distinguished names.
GetDistinguishedNamesRequest.Builder	Builder for GetDistinguishedNamesRequest.
GetDistinguishedNamesResponse
GetDistinguishedNamesResponse.Builder	Builder for GetDistinguishedNamesResponse.
GetNodeCertificatesRequest	Retrieves the specified node's security certificates.
GetNodeCertificatesRequest.Builder	Builder for GetNodeCertificatesRequest.
GetNodeCertificatesResponse
GetNodeCertificatesResponse.Builder	Builder for GetNodeCertificatesResponse.
GetPermissionsInfoRequest	Retrieves the evaluated REST API permissions for the currently logged in user.
GetPermissionsInfoRequest.Builder	Builder for GetPermissionsInfoRequest.
GetPermissionsInfoResponse
GetPermissionsInfoResponse.Builder	Builder for GetPermissionsInfoResponse.
GetRoleMappingRequest	Retrieves the specified role mapping.
GetRoleMappingRequest.Builder	Builder for GetRoleMappingRequest.
GetRoleMappingResponse
GetRoleMappingResponse.Builder	Builder for GetRoleMappingResponse.
GetRoleMappingsRequest	Retrieves all role mappings.
GetRoleMappingsRequest.Builder	Builder for GetRoleMappingsRequest.
GetRoleMappingsResponse
GetRoleMappingsResponse.Builder	Builder for GetRoleMappingsResponse.
GetRoleRequest	Retrieves one role.
GetRoleRequest.Builder	Builder for GetRoleRequest.
GetRoleResponse
GetRoleResponse.Builder	Builder for GetRoleResponse.
GetRolesRequest	Retrieves all roles.
GetRolesRequest.Builder	Builder for GetRolesRequest.
GetRolesResponse
GetRolesResponse.Builder	Builder for GetRolesResponse.
GetSslinfoRequest	Retrieves information about the SSL configuration.
GetSslinfoRequest.Builder	Builder for GetSslinfoRequest.
GetSslinfoResponse
GetSslinfoResponse.Builder	Builder for GetSslinfoResponse.
GetTenancyConfigRequest	Retrieves the multi-tenancy configuration.
GetTenancyConfigRequest.Builder	Builder for GetTenancyConfigRequest.
GetTenancyConfigResponse
GetTenancyConfigResponse.Builder	Builder for GetTenancyConfigResponse.
GetTenantRequest	Retrieves the specified tenant.
GetTenantRequest.Builder	Builder for GetTenantRequest.
GetTenantResponse
GetTenantResponse.Builder	Builder for GetTenantResponse.
GetTenantsRequest	Retrieves all tenants.
GetTenantsRequest.Builder	Builder for GetTenantsRequest.
GetTenantsResponse
GetTenantsResponse.Builder	Builder for GetTenantsResponse.
GetUserLegacyRequest	Retrieve one user.
GetUserLegacyRequest.Builder	Builder for GetUserLegacyRequest.
GetUserLegacyResponse
GetUserLegacyResponse.Builder	Builder for GetUserLegacyResponse.
GetUserRequest	Retrieve information about the specified internal user.
GetUserRequest.Builder	Builder for GetUserRequest.
GetUserResponse
GetUserResponse.Builder	Builder for GetUserResponse.
GetUsersLegacyRequest	Retrieve all internal users.
GetUsersLegacyRequest.Builder	Builder for GetUsersLegacyRequest.
GetUsersLegacyResponse
GetUsersLegacyResponse.Builder	Builder for GetUsersLegacyResponse.
GetUsersRequest	Retrieve all internal users.
GetUsersRequest.Builder	Builder for GetUsersRequest.
GetUsersResponse
GetUsersResponse.Builder	Builder for GetUsersResponse.
HealthRequest	Checks to see if the Security plugin is running.
HealthRequest.Builder	Builder for HealthRequest.
HealthResponse
HealthResponse.Builder	Builder for HealthResponse.
IndexPermission
IndexPermission.Builder	Builder for IndexPermission.
MigrateRequest	Migrates the security configuration from v6 to v7.
MigrateRequest.Builder	Builder for MigrateRequest.
MigrateResponse
MigrateResponse.Builder	Builder for MigrateResponse.
OpenSearchSecurityAsyncClient	Client for the security namespace.
OpenSearchSecurityClient	Client for the security namespace.
PatchActionGroupRequest	Updates the individual attributes of an action group.
PatchActionGroupRequest.Builder	Builder for PatchActionGroupRequest.
PatchActionGroupResponse
PatchActionGroupResponse.Builder	Builder for PatchActionGroupResponse.
PatchActionGroupsRequest	Creates, updates, or deletes multiple action groups in a single request.
PatchActionGroupsRequest.Builder	Builder for PatchActionGroupsRequest.
PatchActionGroupsResponse
PatchActionGroupsResponse.Builder	Builder for PatchActionGroupsResponse.
PatchAllowlistRequest	Updates the current list of APIs accessible for users on the allow list.
PatchAllowlistRequest.Builder	Builder for PatchAllowlistRequest.
PatchAllowlistResponse
PatchAllowlistResponse.Builder	Builder for PatchAllowlistResponse.
PatchAuditConfigurationRequest	Updates the specified fields in the audit configuration.
PatchAuditConfigurationRequest.Builder	Builder for PatchAuditConfigurationRequest.
PatchAuditConfigurationResponse
PatchAuditConfigurationResponse.Builder	Builder for PatchAuditConfigurationResponse.
PatchConfigurationRequest	Updates the existing security configuration using the REST API.
PatchConfigurationRequest.Builder	Builder for PatchConfigurationRequest.
PatchConfigurationResponse
PatchConfigurationResponse.Builder	Builder for PatchConfigurationResponse.
PatchDistinguishedNameRequest	Updates the distinguished cluster name for the specified cluster.
PatchDistinguishedNameRequest.Builder	Builder for PatchDistinguishedNameRequest.
PatchDistinguishedNameResponse
PatchDistinguishedNameResponse.Builder	Builder for PatchDistinguishedNameResponse.
PatchDistinguishedNamesRequest	Bulk updates specified node distinguished names.
PatchDistinguishedNamesRequest.Builder	Builder for PatchDistinguishedNamesRequest.
PatchDistinguishedNamesResponse
PatchDistinguishedNamesResponse.Builder	Builder for PatchDistinguishedNamesResponse.
PatchOperation
PatchOperation.Builder	Builder for PatchOperation.
PatchRoleMappingRequest	Updates the individual attributes of a role mapping.
PatchRoleMappingRequest.Builder	Builder for PatchRoleMappingRequest.
PatchRoleMappingResponse
PatchRoleMappingResponse.Builder	Builder for PatchRoleMappingResponse.
PatchRoleMappingsRequest	Creates or updates multiple role mappings in a single request.
PatchRoleMappingsRequest.Builder	Builder for PatchRoleMappingsRequest.
PatchRoleMappingsResponse
PatchRoleMappingsResponse.Builder	Builder for PatchRoleMappingsResponse.
PatchRoleRequest	Updates the individual attributes of a role.
PatchRoleRequest.Builder	Builder for PatchRoleRequest.
PatchRoleResponse
PatchRoleResponse.Builder	Builder for PatchRoleResponse.
PatchRolesRequest	Creates, updates, or deletes multiple roles in a single call.
PatchRolesRequest.Builder	Builder for PatchRolesRequest.
PatchRolesResponse
PatchRolesResponse.Builder	Builder for PatchRolesResponse.
PatchTenantRequest	Adds, deletes, or modifies a single tenant.
PatchTenantRequest.Builder	Builder for PatchTenantRequest.
PatchTenantResponse
PatchTenantResponse.Builder	Builder for PatchTenantResponse.
PatchTenantsRequest	Adds, deletes, or modifies multiple tenants in a single request.
PatchTenantsRequest.Builder	Builder for PatchTenantsRequest.
PatchTenantsResponse
PatchTenantsResponse.Builder	Builder for PatchTenantsResponse.
PatchUserRequest	Updates individual attributes for an internal user.
PatchUserRequest.Builder	Builder for PatchUserRequest.
PatchUserResponse
PatchUserResponse.Builder	Builder for PatchUserResponse.
PatchUsersRequest	Creates, updates, or deletes multiple internal users in a single request.
PatchUsersRequest.Builder	Builder for PatchUsersRequest.
PatchUsersResponse
PatchUsersResponse.Builder	Builder for PatchUsersResponse.
PostDashboardsInfoRequest	Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
PostDashboardsInfoRequest.Builder	Builder for PostDashboardsInfoRequest.
PostDashboardsInfoResponse
PostDashboardsInfoResponse.Builder	Builder for PostDashboardsInfoResponse.
ReloadHttpCertificatesRequest	Reloads the HTTP communication certificates.
ReloadHttpCertificatesRequest.Builder	Builder for ReloadHttpCertificatesRequest.
ReloadHttpCertificatesResponse
ReloadHttpCertificatesResponse.Builder	Builder for ReloadHttpCertificatesResponse.
ReloadTransportCertificatesRequest	Reloads the transport communication certificates.
ReloadTransportCertificatesRequest.Builder	Builder for ReloadTransportCertificatesRequest.
ReloadTransportCertificatesResponse
ReloadTransportCertificatesResponse.Builder	Builder for ReloadTransportCertificatesResponse.
Role
Role.Builder	Builder for Role.
RoleMapping
RoleMapping.Builder	Builder for RoleMapping.
Tenant
Tenant.Builder	Builder for Tenant.
TenantInfoRequest	Retrieves the names of current tenants.
TenantInfoRequest.Builder	Builder for TenantInfoRequest.
TenantInfoResponse
TenantInfoResponse.Builder	Builder for TenantInfoResponse.
TenantPermission
TenantPermission.Builder	Builder for TenantPermission.
UpdateAuditConfigurationRequest	Updates the audit configuration.
UpdateAuditConfigurationRequest.Builder	Builder for UpdateAuditConfigurationRequest.
UpdateAuditConfigurationResponse
UpdateAuditConfigurationResponse.Builder	Builder for UpdateAuditConfigurationResponse.
UpdateConfigurationRequest	Updates the settings for an existing security configuration.
UpdateConfigurationRequest.Builder	Builder for UpdateConfigurationRequest.
UpdateConfigurationResponse
UpdateConfigurationResponse.Builder	Builder for UpdateConfigurationResponse.
UpdateDistinguishedNameRequest	Adds or updates the specified distinguished names in the cluster or node allowlist.
UpdateDistinguishedNameRequest.Builder	Builder for UpdateDistinguishedNameRequest.
UpdateDistinguishedNameResponse
UpdateDistinguishedNameResponse.Builder	Builder for UpdateDistinguishedNameResponse.
User
User.Builder	Builder for User.
UserTenants
UserTenants.Builder	Builder for UserTenants.
ValidateRequest	Checks whether the v6 security configuration is valid and ready to be migrated to v7.
ValidateRequest.Builder	Builder for ValidateRequest.
ValidateResponse
ValidateResponse.Builder	Builder for ValidateResponse.
WhoAmIProtectedRequest	Gets the identity information for the user currently logged in.
WhoAmIProtectedRequest.Builder	Builder for WhoAmIProtectedRequest.
WhoAmIProtectedResponse
WhoAmIProtectedResponse.Builder	Builder for WhoAmIProtectedResponse.
WhoAmIRequest	Gets the identity information for the user currently logged in.
WhoAmIRequest.Builder	Builder for WhoAmIRequest.
WhoAmIResponse
WhoAmIResponse.Builder	Builder for WhoAmIResponse.