Class: DatadogAPIClient::V2::CloudAuthenticationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/cloud_authentication_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CloudAuthenticationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 22

def initialize(api_client = DatadogAPIClient::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/v2/api/cloud_authentication_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_aws_cloud_auth_persona_mapping(body, opts = {}) ⇒ Object

Create an AWS cloud authentication persona mapping.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 29

def create_aws_cloud_auth_persona_mapping(body, opts = {})
  data, _status_code, _headers = create_aws_cloud_auth_persona_mapping_with_http_info(body, opts)
  data
end

#create_aws_cloud_auth_persona_mapping_with_http_info(body, opts = {}) ⇒ Array<(AWSCloudAuthPersonaMappingResponse, Integer, Hash)>

Create an AWS cloud authentication persona mapping.

Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • AWSCloudAuthPersonaMappingResponse data, response status code and response headers



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
91
92
93
94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 41

def create_aws_cloud_auth_persona_mapping_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_aws_cloud_auth_persona_mapping".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_aws_cloud_auth_persona_mapping")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_aws_cloud_auth_persona_mapping"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.create_aws_cloud_auth_persona_mapping ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudAuthenticationAPI.create_aws_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/aws/persona_mapping'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :create_aws_cloud_auth_persona_mapping,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {}) ⇒ Object

Delete an AWS cloud authentication persona mapping.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 102

def delete_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
  delete_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
  nil
end

#delete_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an AWS cloud authentication persona mapping.

Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user.

Parameters:

  • The ID of the persona mapping

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 114

def delete_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_aws_cloud_auth_persona_mapping".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_aws_cloud_auth_persona_mapping")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_aws_cloud_auth_persona_mapping"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.delete_aws_cloud_auth_persona_mapping ...'
  end
  # verify the required parameter 'persona_mapping_id' is set
  if @api_client.config.client_side_validation && persona_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'persona_mapping_id' when calling CloudAuthenticationAPI.delete_aws_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/aws/persona_mapping/{persona_mapping_id}'.sub('{persona_mapping_id}', CGI.escape(persona_mapping_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :delete_aws_cloud_auth_persona_mapping,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {}) ⇒ Object

Get an AWS cloud authentication persona mapping.

See Also:



173
174
175
176
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 173

def get_aws_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
  data, _status_code, _headers = get_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
  data
end

#get_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {}) ⇒ Array<(AWSCloudAuthPersonaMappingResponse, Integer, Hash)>

Get an AWS cloud authentication persona mapping.

Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user.

Parameters:

  • The ID of the persona mapping

  • (defaults to: {})

    the optional parameters

Returns:

  • AWSCloudAuthPersonaMappingResponse data, response status code and response headers



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 185

def get_aws_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_aws_cloud_auth_persona_mapping".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_aws_cloud_auth_persona_mapping")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_aws_cloud_auth_persona_mapping"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.get_aws_cloud_auth_persona_mapping ...'
  end
  # verify the required parameter 'persona_mapping_id' is set
  if @api_client.config.client_side_validation && persona_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'persona_mapping_id' when calling CloudAuthenticationAPI.get_aws_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/aws/persona_mapping/{persona_mapping_id}'.sub('{persona_mapping_id}', CGI.escape(persona_mapping_id.to_s).gsub('%2F', '/'))

  # 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] || 'AWSCloudAuthPersonaMappingResponse'

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

  new_options = opts.merge(
    :operation => :get_aws_cloud_auth_persona_mapping,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_aws_cloud_auth_persona_mappings(opts = {}) ⇒ Object

List AWS cloud authentication persona mappings.

See Also:



244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 244

def list_aws_cloud_auth_persona_mappings(opts = {})
  data, _status_code, _headers = list_aws_cloud_auth_persona_mappings_with_http_info(opts)
  data
end

#list_aws_cloud_auth_persona_mappings_with_http_info(opts = {}) ⇒ Array<(AWSCloudAuthPersonaMappingsResponse, Integer, Hash)>

List AWS cloud authentication persona mappings.

List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • AWSCloudAuthPersonaMappingsResponse data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 255

def list_aws_cloud_auth_persona_mappings_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_aws_cloud_auth_persona_mappings".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_aws_cloud_auth_persona_mappings")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_aws_cloud_auth_persona_mappings"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.list_aws_cloud_auth_persona_mappings ...'
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/aws/persona_mapping'

  # 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] || 'AWSCloudAuthPersonaMappingsResponse'

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

  new_options = opts.merge(
    :operation => :list_aws_cloud_auth_persona_mappings,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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