opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/api/actions/security/flush_cache.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        FLUSH_CACHE_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Flushes the Security plugin user, authentication, and authorization cache.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache]
+        def flush_cache(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'cache'
+          method  = OpenSearch::API::HTTP_DELETE
+          params  = Utils.__validate_and_extract_params arguments, FLUSH_CACHE_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_account_details.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ACCOUNT_DETAILS_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Returns account details for the current user.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-account-details]
+        def get_account_details(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'account'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ACCOUNT_DETAILS_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_action_group.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ACTION_GROUP_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves one action group.
+        #
+        # @option arguments [String] :action_group *Required* Action group to retrieve.
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-action-group]
+        def get_action_group(arguments = {})
+          raise ArgumentError, "Required argument 'action_group' missing" unless arguments[:action_group]
+
+          arguments = arguments.clone
+          _action_group = arguments.delete(:action_group)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'actiongroups', _action_group
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ACTION_GROUP_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_action_groups.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ACTION_GROUPS_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves all action groups.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups]
+        def get_action_groups(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'actiongroups'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ACTION_GROUPS_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_audit_configuration.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_AUDIT_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves the audit configuration.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#audit-logs]
+        def get_audit_configuration(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'audit'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_AUDIT_CONFIGURATION_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_certificates.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_CERTIFICATES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves the cluster’s security certificates.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-certificates]
+        def get_certificates(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'ssl', 'certs'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_CERTIFICATES_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_configuration.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_CONFIGURATION_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Returns the current Security plugin configuration in JSON format.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration]
+        def get_configuration(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'securityconfig'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_CONFIGURATION_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_distinguished_names.rb

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_DISTINGUISHED_NAMES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves all distinguished names in the allow list.
+        #
+        # @option arguments [String] :cluster_name
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names]
+        def get_distinguished_names(arguments = {})
+          arguments = arguments.clone
+          _cluster_name = arguments.delete(:cluster_name)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'nodesdn', _cluster_name
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_DISTINGUISHED_NAMES_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_role.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ROLE_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves one role.
+        #
+        # @option arguments [String] :role *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role]
+        def get_role(arguments = {})
+          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+
+          arguments = arguments.clone
+          _role = arguments.delete(:role)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles', _role
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_QUERY_PARAMS
+
+          perform_request_complex_ignore404(method, url, params, body, headers, arguments)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_role_mapping.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ROLE_MAPPING_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves one role mapping.
+        #
+        # @option arguments [String] :role *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping]
+        def get_role_mapping(arguments = {})
+          raise ArgumentError, "Required argument 'role' missing" unless arguments[:role]
+
+          arguments = arguments.clone
+          _role = arguments.delete(:role)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'rolesmapping', _role
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_MAPPING_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_role_mappings.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ROLE_MAPPINGS_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves all role mappings.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings]
+        def get_role_mappings(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'rolesmapping'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ROLE_MAPPINGS_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_roles.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_ROLES_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves all roles.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-roles]
+        def get_roles(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'roles'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_ROLES_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_tenant.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_TENANT_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves one tenant.
+        #
+        # @option arguments [String] :tenant *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant]
+        def get_tenant(arguments = {})
+          raise ArgumentError, "Required argument 'tenant' missing" unless arguments[:tenant]
+
+          arguments = arguments.clone
+          _tenant = arguments.delete(:tenant)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants', _tenant
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_TENANT_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_tenants.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_TENANTS_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieves all tenants.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants]
+        def get_tenants(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'tenants'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_TENANTS_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_user.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_USER_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieve one internal user.
+        #
+        # @option arguments [String] :username *Required*
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-user]
+        def get_user(arguments = {})
+          raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
+
+          arguments = arguments.clone
+          _username = arguments.delete(:username)
+
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'internalusers', _username
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_USER_QUERY_PARAMS
+
+          perform_request_complex_ignore404(method, url, params, body, headers, arguments)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/get_users.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        GET_USERS_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Retrieve all internal users.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#get-users]
+        def get_users(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'api', 'internalusers'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, GET_USERS_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/security/health.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Security
+      module Actions
+        HEALTH_QUERY_PARAMS = Set.new(%i[
+        ]).freeze
+
+        # Checks to see if the Security plugin is up and running.
+        #
+        #
+        # {API Reference}[https://opensearch.org/docs/latest/security/access-control/api/#health-check]
+        def health(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+          body    = arguments.delete(:body)
+          url     = Utils.__pathify '_plugins', '_security', 'health'
+          method  = OpenSearch::API::HTTP_GET
+          params  = Utils.__validate_and_extract_params arguments, HEALTH_QUERY_PARAMS
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end