Sha256: 090d7d079bbc8c34da51b013fc2ce7d440650acee86cf1e905e3e8dd1d25eb0f

Contents?: true

Size: 1.96 KB

Versions: 9

Compression:

Stored size: 1.96 KB

Contents

# 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 an API key for access without requiring basic authentication.
          #
          # @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] :body The api key request to create an API key. (*Required*)
          #
          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
          #
          def create_api_key(arguments={})
            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

            valid_params = [ :refresh ]

            method = Elasticsearch::API::HTTP_PUT
            path   = "_security/api_key"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params

            perform_request(method, path, params, arguments[:body]).body
          end
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
elasticsearch-xpack-6.8.1 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-7.2.1 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-7.2.0 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-7.1.0 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-6.8.0 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-6.3.1 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-7.0.0 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-7.0.0.pre lib/elasticsearch/xpack/api/actions/security/create_api_key.rb
elasticsearch-xpack-6.3.0 lib/elasticsearch/xpack/api/actions/security/create_api_key.rb