Sha256: cccc681c418f1d07c375cd44e44a15cc6f3c52cd3645b9165f53c85147c7ac97

Contents?: true

Size: 1.46 KB

Versions: 8

Compression:

Stored size: 1.46 KB

Contents

module Elasticsearch
  module XPack
    module API
      module Security
        module Actions

          # Add a mapping for a role
          #
          # @option arguments [String] :name Role-mapping name (*Required*)
          # @option arguments [Hash] :body The role to add (*Required*)
          # @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)
          #
          # @see https://www.elastic.co/guide/en/x-pack/master/security-api-role-mapping.html#security-api-put-role-mapping
          #
          def put_role_mapping(arguments={})
            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
            valid_params = [
              :name,
              :refresh ]

            arguments = arguments.clone
            name = arguments.delete(:name)

            method = Elasticsearch::API::HTTP_PUT
            path   = "_xpack/security/role_mapping/#{name}"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
            body   = arguments[:body]

            perform_request(method, path, params, body).body
          end
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
elasticsearch-xpack-6.8.1 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.8.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.3.1 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.3.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.2.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.1.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-6.0.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb
elasticsearch-xpack-5.5.0 lib/elasticsearch/xpack/api/actions/security/put_role_mapping.rb