lib/elasticsearch/xpack/api/actions/security/clear_cached_realms.rb in elasticsearch-xpack-7.6.0 vs lib/elasticsearch/xpack/api/actions/security/clear_cached_realms.rb in elasticsearch-xpack-7.7.0.pre
- old
+ new
@@ -5,31 +5,32 @@
module Elasticsearch
module XPack
module API
module Security
module Actions
- # TODO: Description
-
+ # Evicts users from the user cache. Can completely clear the cache or evict specific users.
#
# @option arguments [List] :realms Comma-separated list of realms to clear
# @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache
-
+ # @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
#
def clear_cached_realms(arguments = {})
raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
+ headers = arguments.delete(:headers) || {}
+
arguments = arguments.clone
_realms = arguments.delete(:realms)
method = Elasticsearch::API::HTTP_POST
path = "_security/realm/#{Elasticsearch::API::Utils.__listify(_realms)}/_clear_cache"
params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
body = nil
- perform_request(method, path, params, body).body
+ perform_request(method, path, params, body, headers).body
end
# Register this action with its valid params when the module is loaded.
#
# @since 6.2.0