elasticsearch-xpack 7.12.0 → 7.13.0.pre

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-create-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-create-api-key.html
           #
           def create_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/security/create_service_token.rb

@@ -0,0 +1,73 @@
+# 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 XPack
+    module API
+      module Security
+        module Actions
+          # Creates a service account token for access without requiring basic authentication.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
+          #
+          # @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/7.x/security-api-create-service-token.html
+          #
+          def create_service_token(arguments = {})
+            raise ArgumentError, "Required argument 'namespace' missing" unless arguments[:namespace]
+            raise ArgumentError, "Required argument 'service' missing" unless arguments[:service]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _namespace = arguments.delete(:namespace)
+
+            _service = arguments.delete(:service)
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = if _namespace && _service && _name
+                       "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}/#{Elasticsearch::API::Utils.__listify(_service)}/credential/token/#{Elasticsearch::API::Utils.__listify(_name)}"
+                     else
+                       "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}/#{Elasticsearch::API::Utils.__listify(_service)}/credential/token"
+                     end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            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
+          ParamsRegistry.register(:create_service_token, [
+            :refresh
+          ].freeze)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/security/delete_privileges.rb

@@ -27,7 +27,7 @@ module Elasticsearch
           # @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/7.12/security-api-delete-privilege.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-privilege.html
           #
           def delete_privileges(arguments = {})
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @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/7.12/security-api-delete-role.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-role.html
           #
           def delete_role(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @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/7.12/security-api-delete-role-mapping.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-role-mapping.html
           #
           def delete_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]

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

@@ -0,0 +1,70 @@
+# 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 XPack
+    module API
+      module Security
+        module Actions
+          # Deletes a service account token.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
+          #
+          # @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/7.x/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) || {}
+
+            arguments = arguments.clone
+
+            _namespace = arguments.delete(:namespace)
+
+            _service = arguments.delete(:service)
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}/#{Elasticsearch::API::Utils.__listify(_service)}/credential/token/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            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
+          ParamsRegistry.register(:delete_service_token, [
+            :refresh
+          ].freeze)
+        end
+      end
+    end
+  end
+end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @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/7.12/security-api-delete-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-user.html
           #
           def delete_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @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/7.12/security-api-disable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-disable-user.html
           #
           def disable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @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/7.12/security-api-enable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-enable-user.html
           #
           def enable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]

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

@@ -29,7 +29,7 @@ module Elasticsearch
           # @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/7.12/security-api-get-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-api-key.html
           #
           def get_api_key(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-builtin-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-builtin-privileges.html
           #
           def get_builtin_privileges(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :name Privilege name
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-privileges.html
           #
           def get_privileges(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/security/get_role.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :name A comma-separated list of role names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-role.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-role.html
           #
           def get_role(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/security/get_role_mapping.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :name A comma-separated list of role-mapping names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-role-mapping.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-role-mapping.html
           #
           def get_role_mapping(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/security/get_service_accounts.rb

@@ -0,0 +1,61 @@
+# 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 XPack
+    module API
+      module Security
+        module Actions
+          # Retrieves information about service accounts.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
+          #
+          # @option arguments [String] :namespace An identifier for the namespace
+          # @option arguments [String] :service An identifier for the service name
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-service-accounts.html
+          #
+          def get_service_accounts(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _namespace = arguments.delete(:namespace)
+
+            _service = arguments.delete(:service)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _namespace && _service
+                       "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}/#{Elasticsearch::API::Utils.__listify(_service)}"
+                     elsif _namespace
+                       "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}"
+                     else
+                       "_security/service"
+                     end
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/security/get_service_credentials.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 XPack
+    module API
+      module Security
+        module Actions
+          # Retrieves information of all service credentials for a service account.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
+          #
+          # @option arguments [String] :namespace An identifier for the namespace
+          # @option arguments [String] :service An identifier for the service name
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-service-credentials.html
+          #
+          def get_service_credentials(arguments = {})
+            raise ArgumentError, "Required argument 'namespace' missing" unless arguments[:namespace]
+            raise ArgumentError, "Required argument 'service' missing" unless arguments[:service]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _namespace = arguments.delete(:namespace)
+
+            _service = arguments.delete(:service)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_security/service/#{Elasticsearch::API::Utils.__listify(_namespace)}/#{Elasticsearch::API::Utils.__listify(_service)}/credential"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/security/get_token.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The token request to get (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-token.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-token.html
           #
           def get_token(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/security/get_user.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :username A comma-separated list of usernames
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-user.html
           #
           def get_user(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/security/get_user_privileges.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-get-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-privileges.html
           #
           def get_user_privileges(arguments = {})
             headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/xpack/api/actions/security/grant_api_key.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-grant-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-grant-api-key.html
           #
           def grant_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/security/has_privileges.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The privileges to test (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-has-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-has-privileges.html
           #
           def has_privileges(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

data/lib/elasticsearch/xpack/api/actions/security/invalidate_api_key.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/security-api-invalidate-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-invalidate-api-key.html
           #
           def invalidate_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]