Class: DatadogAPIClient::V1::AuthenticationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/authentication_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ AuthenticationAPI

Returns a new instance of AuthenticationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/authentication_api.rb', line 22

def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v1/api/authentication_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#validate(opts = {}) ⇒ Object

Validate API key.

See Also:



29
30
31
32
 
# 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 = {}) ⇒ Array<(AuthenticationValidationResponse, Integer, Hash)>

Validate API key.

Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# 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] || [:AuthZ, :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