elasticsearch-api 7.17.11 → 9.0.2

data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb

@@ -0,0 +1,56 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Bulk delete roles.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The bulk delete roles API cannot delete roles that are defined in roles files.
+        #
+        # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-delete-role
+        #
+        def bulk_delete_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_delete_role' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = '_security/role'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/bulk_put_role.rb

@@ -0,0 +1,56 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Bulk create or update roles.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The bulk create or update roles API cannot update roles that are defined in roles files.
+        #
+        # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-put-role
+        #
+        def bulk_put_role(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_put_role' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_security/role'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Bulk update API keys.
+        # Update the attributes for multiple API keys.
+        # IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.
+        # This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.
+        # It is not possible to update expired or invalidated API keys.
+        # This API supports updates to API key access scope, metadata and expiration.
+        # The access scope of each API key is derived from the +role_descriptors+ you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+        # The snapshot of the owner's permissions is updated automatically on every call.
+        # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.
+        # A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-update-api-keys
+        #
+        def bulk_update_api_keys(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_update_api_keys' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_security/api_key/_bulk_update'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/change_password.rb

@@ -0,0 +1,68 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Change passwords.
+        # Change the passwords of users in the native realm and built-in users.
+        #
+        # @option arguments [String] :username The user whose password you want to change. If you do not specify this
+        #  parameter, the password is changed for the current user.
+        # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-change-password
+        #
+        def change_password(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.change_password' }
+
+          defined_params = [:username].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _username = arguments.delete(:username)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _username
+                     "_security/user/#{Utils.listify(_username)}/_password"
+                   else
+                     '_security/user/_password'
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Clear the API key cache.
+        # Evict a subset of all entries from the API key cache.
+        # The cache is also automatically cleared on state changes of the security index.
+        #
+        # @option arguments [String, Array] :ids Comma-separated list of API key IDs to evict from the API key cache.
+        #  To evict all API keys, use +*+.
+        #  Does not support other wildcard patterns. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-api-key-cache
+        #
+        def clear_api_key_cache(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.clear_api_key_cache' }
+
+          defined_params = [:ids].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'ids' missing" unless arguments[:ids]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _ids = arguments.delete(:ids)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_security/api_key/#{Utils.listify(_ids)}/_clear_cache"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Clear the privileges cache.
+        # Evict privileges from the native application privilege cache.
+        # The cache is also automatically cleared for applications that have their privileges updated.
+        #
+        # @option arguments [String] :application A comma-separated list of applications.
+        #  To clear all applications, use an asterism (+*+).
+        #  It does not support other wildcard patterns. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-privileges
+        #
+        def clear_cached_privileges(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_privileges' }
+
+          defined_params = [:application].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _application = arguments.delete(:application)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_security/privilege/#{Utils.listify(_application)}/_clear_cache"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb

@@ -0,0 +1,69 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Clear the user cache.
+        # Evict users from the user cache.
+        # You can completely clear the cache or evict specific users.
+        # User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.
+        # There are realm settings that you can use to configure the user cache.
+        # For more information, refer to the documentation about controlling the user cache.
+        #
+        # @option arguments [String, Array<String>] :realms A comma-separated list of realms.
+        #  To clear all realms, use an asterisk (+*+).
+        #  It does not support other wildcard patterns. (*Required*)
+        # @option arguments [Array<String>] :usernames A comma-separated list of the users to clear from the cache.
+        #  If you do not specify this parameter, the API evicts all users from the user cache.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-realms
+        #
+        def clear_cached_realms(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_realms' }
+
+          defined_params = [:realms].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _realms = arguments.delete(:realms)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_security/realm/#{Utils.listify(_realms)}/_clear_cache"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Clear the roles cache.
+        # Evict roles from the native role cache.
+        #
+        # @option arguments [String, Array<String>] :name A comma-separated list of roles to evict from the role cache.
+        #  To evict all roles, use an asterisk (+*+).
+        #  It does not support other wildcard patterns. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-roles
+        #
+        def clear_cached_roles(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_roles' }
+
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_security/role/#{Utils.listify(_name)}/_clear_cache"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb

@@ -0,0 +1,75 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Clear service account token caches.
+        # Evict a subset of all entries from the service account token caches.
+        # Two separate caches exist for service account tokens: one cache for tokens backed by the +service_tokens+ file, and another for tokens backed by the +.security+ index.
+        # This API clears matching entries from both caches.
+        # The cache for service account tokens backed by the +.security+ index is cleared automatically on state changes of the security index.
+        # The cache for tokens backed by the +service_tokens+ file is cleared automatically on file changes.
+        #
+        # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
+        # @option arguments [String] :service The name of the service, which must be unique within its namespace. (*Required*)
+        # @option arguments [String, Array<String>] :name A comma-separated list of token names to evict from the service account token caches.
+        #  Use a wildcard (+*+) to evict all tokens that belong to a service account.
+        #  It does not support other wildcard patterns. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-service-tokens
+        #
+        def clear_cached_service_tokens(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_service_tokens' }
+
+          defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'namespace' missing" unless arguments[:namespace]
+          raise ArgumentError, "Required argument 'service' missing" unless arguments[:service]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _namespace = arguments.delete(:namespace)
+
+          _service = arguments.delete(:service)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}/_clear_cache"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/security/create_api_key.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Create an API key.
+        # Create an API key for access without requiring basic authentication.
+        # IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.
+        # If you specify privileges, the API returns an error.
+        # A successful request returns a JSON structure that contains the API key, its unique id, and its name.
+        # If applicable, it also returns expiration information for the API key in milliseconds.
+        # NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
+        # The API keys are created by the Elasticsearch API key service, which is automatically enabled.
+        # To configure or turn off the API key service, refer to API key service setting documentation.
+        #
+        # @option arguments [String] :refresh If +true+ (the default) then refresh the affected shards to make this operation visible to search, if +wait_for+ then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-api-key
+        #
+        def create_api_key(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'security.create_api_key' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = '_security/api_key'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end