elasticsearch-api 7.17.7 → 8.0.0.pre1

data/lib/elasticsearch/api/actions/security/delete_privileges.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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Removes application privileges.
+        #
+        # @option arguments [String] :application Application name
+        # @option arguments [String] :name Privilege name
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html
+        #
+        def delete_privileges(arguments = {})
+          raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _application = arguments.delete(:application)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_security/privilege/#{Utils.__listify(_application)}/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Removes roles in the native realm.
+        #
+        # @option arguments [String] :name Role name
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
+        #
+        def delete_role(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_security/role/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Removes role mappings.
+        #
+        # @option arguments [String] :name Role-mapping name
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html
+        #
+        def delete_role_mapping(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_security/role_mapping/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Deletes a service account token.
+        #
+        # @option arguments [String] :namespace An identifier for the namespace
+        # @option arguments [String] :service An identifier for the service name
+        # @option arguments [String] :name An identifier for the token name
+        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html
+        #
+        def delete_service_token(arguments = {})
+          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]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _namespace = arguments.delete(:namespace)
+
+          _service = arguments.delete(:service)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Deletes users from the native realm.
+        #
+        # @option arguments [String] :username username
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
+        #
+        def delete_user(arguments = {})
+          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _username = arguments.delete(:username)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_security/user/#{Utils.__listify(_username)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Disables users in the native realm.
+        #
+        # @option arguments [String] :username The username of the user to disable
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
+        #
+        def disable_user(arguments = {})
+          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _username = arguments.delete(:username)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_security/user/#{Utils.__listify(_username)}/_disable"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Enables users in the native realm.
+        #
+        # @option arguments [String] :username The username of the user to enable
+        # @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. (options: true, false, wait_for)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
+        #
+        def enable_user(arguments = {})
+          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _username = arguments.delete(:username)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_security/user/#{Utils.__listify(_username)}/_enable"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html
+        #
+        def enroll_kibana(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_security/enroll/kibana"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Allows a new node to enroll to an existing cluster with security enabled.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html
+        #
+        def enroll_node(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_security/enroll/node"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Retrieves information for one or more API keys.
+        #
+        # @option arguments [String] :id API key id of the API key to be retrieved
+        # @option arguments [String] :name API key name of the API key to be retrieved
+        # @option arguments [String] :username user name of the user who created this API key to be retrieved
+        # @option arguments [String] :realm_name realm name of the user who created this API key to be retrieved
+        # @option arguments [Boolean] :owner flag to query API keys owned by the currently authenticated user
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
+        #
+        def get_api_key(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_security/api_key"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
+        #
+        def get_builtin_privileges(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_security/privilege/_builtin"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Security
+      module Actions
+        # Retrieves application privileges.
+        #
+        # @option arguments [String] :application Application name
+        # @option arguments [String] :name Privilege name
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
+        #
+        def get_privileges(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _application = arguments.delete(:application)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _application && _name
+                     "_security/privilege/#{Utils.__listify(_application)}/#{Utils.__listify(_name)}"
+                   elsif _application
+                     "_security/privilege/#{Utils.__listify(_application)}"
+                   else
+                     "_security/privilege"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end