Struct elasticsearch::security::Security
source · pub struct Security<'a> { /* private fields */ }
Expand description
Namespace client for Security APIs
Implementations
sourceimpl<'a> Security<'a>
impl<'a> Security<'a>
pub fn transport(&self) -> &Transport
sourcepub fn activate_user_profile<'b>(
&'a self
) -> SecurityActivateUserProfile<'a, 'b, ()>
pub fn activate_user_profile<'b>(
&'a self
) -> SecurityActivateUserProfile<'a, 'b, ()>
Security Activate User Profile API
Creates or updates the user profile on behalf of another user.
sourcepub fn authenticate<'b>(&'a self) -> SecurityAuthenticate<'a, 'b>
pub fn authenticate<'b>(&'a self) -> SecurityAuthenticate<'a, 'b>
Enables authentication as a user and retrieve information about the authenticated user.
sourcepub fn bulk_update_api_keys<'b>(
&'a self
) -> SecurityBulkUpdateApiKeys<'a, 'b, ()>
pub fn bulk_update_api_keys<'b>(
&'a self
) -> SecurityBulkUpdateApiKeys<'a, 'b, ()>
Security Bulk Update Api Keys API
Updates the attributes of multiple existing API keys.
sourcepub fn change_password<'b>(
&'a self,
parts: SecurityChangePasswordParts<'b>
) -> SecurityChangePassword<'a, 'b, ()>
pub fn change_password<'b>(
&'a self,
parts: SecurityChangePasswordParts<'b>
) -> SecurityChangePassword<'a, 'b, ()>
Changes the passwords of users in the native realm and built-in users.
sourcepub fn clear_api_key_cache<'b>(
&'a self,
parts: SecurityClearApiKeyCacheParts<'b>
) -> SecurityClearApiKeyCache<'a, 'b, ()>
pub fn clear_api_key_cache<'b>(
&'a self,
parts: SecurityClearApiKeyCacheParts<'b>
) -> SecurityClearApiKeyCache<'a, 'b, ()>
Security Clear Api Key Cache API
Clear a subset or all entries from the API key cache.
sourcepub fn clear_cached_privileges<'b>(
&'a self,
parts: SecurityClearCachedPrivilegesParts<'b>
) -> SecurityClearCachedPrivileges<'a, 'b, ()>
pub fn clear_cached_privileges<'b>(
&'a self,
parts: SecurityClearCachedPrivilegesParts<'b>
) -> SecurityClearCachedPrivileges<'a, 'b, ()>
Security Clear Cached Privileges API
Evicts application privileges from the native application privileges cache.
sourcepub fn clear_cached_realms<'b>(
&'a self,
parts: SecurityClearCachedRealmsParts<'b>
) -> SecurityClearCachedRealms<'a, 'b, ()>
pub fn clear_cached_realms<'b>(
&'a self,
parts: SecurityClearCachedRealmsParts<'b>
) -> SecurityClearCachedRealms<'a, 'b, ()>
Security Clear Cached Realms API
Evicts users from the user cache. Can completely clear the cache or evict specific users.
sourcepub fn clear_cached_roles<'b>(
&'a self,
parts: SecurityClearCachedRolesParts<'b>
) -> SecurityClearCachedRoles<'a, 'b, ()>
pub fn clear_cached_roles<'b>(
&'a self,
parts: SecurityClearCachedRolesParts<'b>
) -> SecurityClearCachedRoles<'a, 'b, ()>
Security Clear Cached Roles API
Evicts roles from the native role cache.
sourcepub fn clear_cached_service_tokens<'b>(
&'a self,
parts: SecurityClearCachedServiceTokensParts<'b>
) -> SecurityClearCachedServiceTokens<'a, 'b, ()>
pub fn clear_cached_service_tokens<'b>(
&'a self,
parts: SecurityClearCachedServiceTokensParts<'b>
) -> SecurityClearCachedServiceTokens<'a, 'b, ()>
Security Clear Cached Service Tokens API
Evicts tokens from the service account token caches.
sourcepub fn create_api_key<'b>(&'a self) -> SecurityCreateApiKey<'a, 'b, ()>
pub fn create_api_key<'b>(&'a self) -> SecurityCreateApiKey<'a, 'b, ()>
Creates an API key for access without requiring basic authentication.
sourcepub fn create_service_token<'b>(
&'a self,
parts: SecurityCreateServiceTokenParts<'b>
) -> SecurityCreateServiceToken<'a, 'b, ()>
pub fn create_service_token<'b>(
&'a self,
parts: SecurityCreateServiceTokenParts<'b>
) -> SecurityCreateServiceToken<'a, 'b, ()>
Security Create Service Token API
Creates a service account token for access without requiring basic authentication.
sourcepub fn delete_privileges<'b>(
&'a self,
parts: SecurityDeletePrivilegesParts<'b>
) -> SecurityDeletePrivileges<'a, 'b>
pub fn delete_privileges<'b>(
&'a self,
parts: SecurityDeletePrivilegesParts<'b>
) -> SecurityDeletePrivileges<'a, 'b>
Security Delete Privileges API
Removes application privileges.
sourcepub fn delete_role<'b>(
&'a self,
parts: SecurityDeleteRoleParts<'b>
) -> SecurityDeleteRole<'a, 'b>
pub fn delete_role<'b>(
&'a self,
parts: SecurityDeleteRoleParts<'b>
) -> SecurityDeleteRole<'a, 'b>
Removes roles in the native realm.
sourcepub fn delete_role_mapping<'b>(
&'a self,
parts: SecurityDeleteRoleMappingParts<'b>
) -> SecurityDeleteRoleMapping<'a, 'b>
pub fn delete_role_mapping<'b>(
&'a self,
parts: SecurityDeleteRoleMappingParts<'b>
) -> SecurityDeleteRoleMapping<'a, 'b>
Security Delete Role Mapping API
Removes role mappings.
sourcepub fn delete_service_token<'b>(
&'a self,
parts: SecurityDeleteServiceTokenParts<'b>
) -> SecurityDeleteServiceToken<'a, 'b>
pub fn delete_service_token<'b>(
&'a self,
parts: SecurityDeleteServiceTokenParts<'b>
) -> SecurityDeleteServiceToken<'a, 'b>
Security Delete Service Token API
Deletes a service account token.
sourcepub fn delete_user<'b>(
&'a self,
parts: SecurityDeleteUserParts<'b>
) -> SecurityDeleteUser<'a, 'b>
pub fn delete_user<'b>(
&'a self,
parts: SecurityDeleteUserParts<'b>
) -> SecurityDeleteUser<'a, 'b>
Deletes users from the native realm.
sourcepub fn disable_user<'b>(
&'a self,
parts: SecurityDisableUserParts<'b>
) -> SecurityDisableUser<'a, 'b, ()>
pub fn disable_user<'b>(
&'a self,
parts: SecurityDisableUserParts<'b>
) -> SecurityDisableUser<'a, 'b, ()>
Disables users in the native realm.
sourcepub fn disable_user_profile<'b>(
&'a self,
parts: SecurityDisableUserProfileParts<'b>
) -> SecurityDisableUserProfile<'a, 'b, ()>
pub fn disable_user_profile<'b>(
&'a self,
parts: SecurityDisableUserProfileParts<'b>
) -> SecurityDisableUserProfile<'a, 'b, ()>
Security Disable User Profile API
Disables a user profile so it’s not visible in user profile searches.
sourcepub fn enable_user<'b>(
&'a self,
parts: SecurityEnableUserParts<'b>
) -> SecurityEnableUser<'a, 'b, ()>
pub fn enable_user<'b>(
&'a self,
parts: SecurityEnableUserParts<'b>
) -> SecurityEnableUser<'a, 'b, ()>
Enables users in the native realm.
sourcepub fn enable_user_profile<'b>(
&'a self,
parts: SecurityEnableUserProfileParts<'b>
) -> SecurityEnableUserProfile<'a, 'b, ()>
pub fn enable_user_profile<'b>(
&'a self,
parts: SecurityEnableUserProfileParts<'b>
) -> SecurityEnableUserProfile<'a, 'b, ()>
Security Enable User Profile API
Enables a user profile so it’s visible in user profile searches.
sourcepub fn enroll_kibana<'b>(&'a self) -> SecurityEnrollKibana<'a, 'b>
pub fn enroll_kibana<'b>(&'a self) -> SecurityEnrollKibana<'a, 'b>
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
sourcepub fn enroll_node<'b>(&'a self) -> SecurityEnrollNode<'a, 'b>
pub fn enroll_node<'b>(&'a self) -> SecurityEnrollNode<'a, 'b>
Allows a new node to enroll to an existing cluster with security enabled.
sourcepub fn get_api_key<'b>(&'a self) -> SecurityGetApiKey<'a, 'b>
pub fn get_api_key<'b>(&'a self) -> SecurityGetApiKey<'a, 'b>
Retrieves information for one or more API keys.
sourcepub fn get_builtin_privileges<'b>(
&'a self
) -> SecurityGetBuiltinPrivileges<'a, 'b>
pub fn get_builtin_privileges<'b>(
&'a self
) -> SecurityGetBuiltinPrivileges<'a, 'b>
Security Get Builtin Privileges API
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
sourcepub fn get_privileges<'b>(
&'a self,
parts: SecurityGetPrivilegesParts<'b>
) -> SecurityGetPrivileges<'a, 'b>
pub fn get_privileges<'b>(
&'a self,
parts: SecurityGetPrivilegesParts<'b>
) -> SecurityGetPrivileges<'a, 'b>
Retrieves application privileges.
sourcepub fn get_role<'b>(
&'a self,
parts: SecurityGetRoleParts<'b>
) -> SecurityGetRole<'a, 'b>
pub fn get_role<'b>(
&'a self,
parts: SecurityGetRoleParts<'b>
) -> SecurityGetRole<'a, 'b>
Retrieves roles in the native realm.
sourcepub fn get_role_mapping<'b>(
&'a self,
parts: SecurityGetRoleMappingParts<'b>
) -> SecurityGetRoleMapping<'a, 'b>
pub fn get_role_mapping<'b>(
&'a self,
parts: SecurityGetRoleMappingParts<'b>
) -> SecurityGetRoleMapping<'a, 'b>
Retrieves role mappings.
sourcepub fn get_service_accounts<'b>(
&'a self,
parts: SecurityGetServiceAccountsParts<'b>
) -> SecurityGetServiceAccounts<'a, 'b>
pub fn get_service_accounts<'b>(
&'a self,
parts: SecurityGetServiceAccountsParts<'b>
) -> SecurityGetServiceAccounts<'a, 'b>
Security Get Service Accounts API
Retrieves information about service accounts.
sourcepub fn get_service_credentials<'b>(
&'a self,
parts: SecurityGetServiceCredentialsParts<'b>
) -> SecurityGetServiceCredentials<'a, 'b>
pub fn get_service_credentials<'b>(
&'a self,
parts: SecurityGetServiceCredentialsParts<'b>
) -> SecurityGetServiceCredentials<'a, 'b>
Security Get Service Credentials API
Retrieves information of all service credentials for a service account.
sourcepub fn get_token<'b>(&'a self) -> SecurityGetToken<'a, 'b, ()>
pub fn get_token<'b>(&'a self) -> SecurityGetToken<'a, 'b, ()>
Creates a bearer token for access without requiring basic authentication.
sourcepub fn get_user<'b>(
&'a self,
parts: SecurityGetUserParts<'b>
) -> SecurityGetUser<'a, 'b>
pub fn get_user<'b>(
&'a self,
parts: SecurityGetUserParts<'b>
) -> SecurityGetUser<'a, 'b>
Retrieves information about users in the native realm and built-in users.
sourcepub fn get_user_privileges<'b>(&'a self) -> SecurityGetUserPrivileges<'a, 'b>
pub fn get_user_privileges<'b>(&'a self) -> SecurityGetUserPrivileges<'a, 'b>
Security Get User Privileges API
Retrieves security privileges for the logged in user.
sourcepub fn get_user_profile<'b>(
&'a self,
parts: SecurityGetUserProfileParts<'b>
) -> SecurityGetUserProfile<'a, 'b>
pub fn get_user_profile<'b>(
&'a self,
parts: SecurityGetUserProfileParts<'b>
) -> SecurityGetUserProfile<'a, 'b>
Retrieves user profiles for the given unique ID(s).
sourcepub fn grant_api_key<'b>(&'a self) -> SecurityGrantApiKey<'a, 'b, ()>
pub fn grant_api_key<'b>(&'a self) -> SecurityGrantApiKey<'a, 'b, ()>
Creates an API key on behalf of another user.
sourcepub fn has_privileges<'b>(
&'a self,
parts: SecurityHasPrivilegesParts<'b>
) -> SecurityHasPrivileges<'a, 'b, ()>
pub fn has_privileges<'b>(
&'a self,
parts: SecurityHasPrivilegesParts<'b>
) -> SecurityHasPrivileges<'a, 'b, ()>
Determines whether the specified user has a specified list of privileges.
sourcepub fn has_privileges_user_profile<'b>(
&'a self
) -> SecurityHasPrivilegesUserProfile<'a, 'b, ()>
pub fn has_privileges_user_profile<'b>(
&'a self
) -> SecurityHasPrivilegesUserProfile<'a, 'b, ()>
Security Has Privileges User Profile API
Determines whether the users associated with the specified profile IDs have all the requested privileges.
sourcepub fn invalidate_api_key<'b>(&'a self) -> SecurityInvalidateApiKey<'a, 'b, ()>
pub fn invalidate_api_key<'b>(&'a self) -> SecurityInvalidateApiKey<'a, 'b, ()>
Security Invalidate Api Key API
Invalidates one or more API keys.
sourcepub fn invalidate_token<'b>(&'a self) -> SecurityInvalidateToken<'a, 'b, ()>
pub fn invalidate_token<'b>(&'a self) -> SecurityInvalidateToken<'a, 'b, ()>
Invalidates one or more access tokens or refresh tokens.
sourcepub fn oidc_authenticate<'b>(&'a self) -> SecurityOidcAuthenticate<'a, 'b, ()>
pub fn oidc_authenticate<'b>(&'a self) -> SecurityOidcAuthenticate<'a, 'b, ()>
Security Oidc Authenticate API
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
sourcepub fn oidc_logout<'b>(&'a self) -> SecurityOidcLogout<'a, 'b, ()>
pub fn oidc_logout<'b>(&'a self) -> SecurityOidcLogout<'a, 'b, ()>
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
sourcepub fn oidc_prepare_authentication<'b>(
&'a self
) -> SecurityOidcPrepareAuthentication<'a, 'b, ()>
pub fn oidc_prepare_authentication<'b>(
&'a self
) -> SecurityOidcPrepareAuthentication<'a, 'b, ()>
Security Oidc Prepare Authentication API
Creates an OAuth 2.0 authentication request as a URL string
sourcepub fn put_privileges<'b>(&'a self) -> SecurityPutPrivileges<'a, 'b, ()>
pub fn put_privileges<'b>(&'a self) -> SecurityPutPrivileges<'a, 'b, ()>
Adds or updates application privileges.
sourcepub fn put_role<'b>(
&'a self,
parts: SecurityPutRoleParts<'b>
) -> SecurityPutRole<'a, 'b, ()>
pub fn put_role<'b>(
&'a self,
parts: SecurityPutRoleParts<'b>
) -> SecurityPutRole<'a, 'b, ()>
Adds and updates roles in the native realm.
sourcepub fn put_role_mapping<'b>(
&'a self,
parts: SecurityPutRoleMappingParts<'b>
) -> SecurityPutRoleMapping<'a, 'b, ()>
pub fn put_role_mapping<'b>(
&'a self,
parts: SecurityPutRoleMappingParts<'b>
) -> SecurityPutRoleMapping<'a, 'b, ()>
Creates and updates role mappings.
sourcepub fn put_user<'b>(
&'a self,
parts: SecurityPutUserParts<'b>
) -> SecurityPutUser<'a, 'b, ()>
pub fn put_user<'b>(
&'a self,
parts: SecurityPutUserParts<'b>
) -> SecurityPutUser<'a, 'b, ()>
Adds and updates users in the native realm. These users are commonly referred to as native users.
sourcepub fn query_api_keys<'b>(&'a self) -> SecurityQueryApiKeys<'a, 'b, ()>
pub fn query_api_keys<'b>(&'a self) -> SecurityQueryApiKeys<'a, 'b, ()>
Retrieves information for API keys using a subset of query DSL
sourcepub fn saml_authenticate<'b>(&'a self) -> SecuritySamlAuthenticate<'a, 'b, ()>
pub fn saml_authenticate<'b>(&'a self) -> SecuritySamlAuthenticate<'a, 'b, ()>
Security Saml Authenticate API
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
sourcepub fn saml_complete_logout<'b>(
&'a self
) -> SecuritySamlCompleteLogout<'a, 'b, ()>
pub fn saml_complete_logout<'b>(
&'a self
) -> SecuritySamlCompleteLogout<'a, 'b, ()>
Security Saml Complete Logout API
Verifies the logout response sent from the SAML IdP
sourcepub fn saml_invalidate<'b>(&'a self) -> SecuritySamlInvalidate<'a, 'b, ()>
pub fn saml_invalidate<'b>(&'a self) -> SecuritySamlInvalidate<'a, 'b, ()>
Consumes a SAML LogoutRequest
sourcepub fn saml_logout<'b>(&'a self) -> SecuritySamlLogout<'a, 'b, ()>
pub fn saml_logout<'b>(&'a self) -> SecuritySamlLogout<'a, 'b, ()>
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
sourcepub fn saml_prepare_authentication<'b>(
&'a self
) -> SecuritySamlPrepareAuthentication<'a, 'b, ()>
pub fn saml_prepare_authentication<'b>(
&'a self
) -> SecuritySamlPrepareAuthentication<'a, 'b, ()>
Security Saml Prepare Authentication API
Creates a SAML authentication request
sourcepub fn saml_service_provider_metadata<'b>(
&'a self,
parts: SecuritySamlServiceProviderMetadataParts<'b>
) -> SecuritySamlServiceProviderMetadata<'a, 'b>
pub fn saml_service_provider_metadata<'b>(
&'a self,
parts: SecuritySamlServiceProviderMetadataParts<'b>
) -> SecuritySamlServiceProviderMetadata<'a, 'b>
Security Saml Service Provider Metadata API
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
sourcepub fn suggest_user_profiles<'b>(
&'a self
) -> SecuritySuggestUserProfiles<'a, 'b, ()>
pub fn suggest_user_profiles<'b>(
&'a self
) -> SecuritySuggestUserProfiles<'a, 'b, ()>
Security Suggest User Profiles API
Get suggestions for user profiles that match specified search criteria.
sourcepub fn update_api_key<'b>(
&'a self,
parts: SecurityUpdateApiKeyParts<'b>
) -> SecurityUpdateApiKey<'a, 'b, ()>
pub fn update_api_key<'b>(
&'a self,
parts: SecurityUpdateApiKeyParts<'b>
) -> SecurityUpdateApiKey<'a, 'b, ()>
Updates attributes of an existing API key.
sourcepub fn update_user_profile_data<'b>(
&'a self,
parts: SecurityUpdateUserProfileDataParts<'b>
) -> SecurityUpdateUserProfileData<'a, 'b, ()>
pub fn update_user_profile_data<'b>(
&'a self,
parts: SecurityUpdateUserProfileDataParts<'b>
) -> SecurityUpdateUserProfileData<'a, 'b, ()>
Security Update User Profile Data API
Update application specific data for the user profile of the given unique ID.