class DatadogAPIClient::V1::AuthenticationAPI

Attributes

api_client[RW]

Public Class Methods

new(api_client = APIClient.default) click to toggle source
# File lib/datadog_api_client/v1/api/authentication_api.rb, line 22
def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Public Instance Methods

validate(opts = {}) click to toggle source

Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. @param [Hash] opts the optional parameters @return [AuthenticationValidationResponse]

# File lib/datadog_api_client/v1/api/authentication_api.rb, line 29
def validate(opts = {})
  data, _status_code, _headers = validate_with_http_info(opts)
  data
end
validate_with_http_info(opts = {}) click to toggle source

Validate API key Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. @param [Hash] opts the optional parameters @return [Array<(AuthenticationValidationResponse, Integer, Hash)>] AuthenticationValidationResponse data, response status code and response headers

# File lib/datadog_api_client/v1/api/authentication_api.rb, line 38
def validate_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:validate)
    unstable_enabled = @api_client.config.unstable_operations[:validate]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "validate")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "validate"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationAPI.validate ...'
  end
  # resource path
  local_var_path = '/api/v1/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AuthenticationValidationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth]

  new_options = opts.merge(
    :operation => :validate,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationAPI#validate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end