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:

Returns:



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, :AuthZ]

  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

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

Create a GitHub cloud auth intake mapping.

See Also:



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

def create_git_hub_cloud_auth_intake_mapping(body, opts = {})
  data, _status_code, _headers = create_git_hub_cloud_auth_intake_mapping_with_http_info(body, opts)
  data
end

#create_git_hub_cloud_auth_intake_mapping_with_http_info(body, opts = {}) ⇒ Array<(GitHubCloudAuthIntakeMappingResponse, Integer, Hash)>

Create a GitHub cloud auth intake mapping.

Create a GitHub cloud authentication intake mapping. This endpoint entitles a matching GitHub Actions OIDC principal to request Datadog API keys.

Parameters:

Returns:



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
169
170
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 114

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.create_git_hub_cloud_auth_intake_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_git_hub_cloud_auth_intake_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/intake_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] || 'GitHubCloudAuthIntakeMappingResponse'

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

  new_options = opts.merge(
    :operation => :create_git_hub_cloud_auth_intake_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_git_hub_cloud_auth_intake_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a GitHub cloud auth persona mapping.

See Also:



175
176
177
178
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 175

def create_git_hub_cloud_auth_persona_mapping(body, opts = {})
  data, _status_code, _headers = create_git_hub_cloud_auth_persona_mapping_with_http_info(body, opts)
  data
end

#create_git_hub_cloud_auth_persona_mapping_with_http_info(body, opts = {}) ⇒ Array<(GitHubCloudAuthPersonaMappingResponse, Integer, Hash)>

Create a GitHub cloud auth persona mapping.

Create a GitHub cloud authentication persona mapping. This endpoint associates a GitHub Actions OIDC principal with a Datadog user. The mapped principal can request an impersonation token.

Parameters:

Returns:



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
240
241
242
243
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 187

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.create_git_hub_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_git_hub_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/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] || 'GitHubCloudAuthPersonaMappingResponse'

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

  new_options = opts.merge(
    :operation => :create_git_hub_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_git_hub_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:



248
249
250
251
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 248

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:

  • persona_mapping_id (String) —

    The ID of the persona mapping

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
306
307
308
309
310
311
312
313
314
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 260

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, :AuthZ]

  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

#delete_git_hub_cloud_auth_intake_mapping(intake_mapping_id, opts = {}) ⇒ Object

Delete a GitHub cloud auth intake mapping.

See Also:



319
320
321
322
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 319

def delete_git_hub_cloud_auth_intake_mapping(intake_mapping_id, opts = {})
  delete_git_hub_cloud_auth_intake_mapping_with_http_info(intake_mapping_id, opts)
  nil
end

#delete_git_hub_cloud_auth_intake_mapping_with_http_info(intake_mapping_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a GitHub cloud auth intake mapping.

Delete a GitHub cloud authentication intake mapping by ID. This removes a GitHub Actions OIDC principal's entitlement to request Datadog API keys.

Parameters:

  • intake_mapping_id (String) —

    The ID of the intake mapping

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 331

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.delete_git_hub_cloud_auth_intake_mapping ...'
  end
  # verify the required parameter 'intake_mapping_id' is set
  if @api_client.config.client_side_validation && intake_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'intake_mapping_id' when calling CloudAuthenticationAPI.delete_git_hub_cloud_auth_intake_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/intake_mapping/{intake_mapping_id}'.sub('{intake_mapping_id}', CGI.escape(intake_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, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_git_hub_cloud_auth_intake_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_git_hub_cloud_auth_intake_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a GitHub cloud auth persona mapping.

See Also:



390
391
392
393
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 390

def delete_git_hub_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
  delete_git_hub_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
  nil
end

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

Delete a GitHub cloud auth persona mapping.

Delete a GitHub cloud authentication persona mapping by ID. This removes the association between a GitHub Actions OIDC principal and a Datadog user.

Parameters:

  • persona_mapping_id (String) —

    The ID of the persona mapping

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 402

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.delete_git_hub_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_git_hub_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/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, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_git_hub_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_git_hub_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:



461
462
463
464
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 461

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:

  • persona_mapping_id (String) —

    The ID of the persona mapping

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

    the optional parameters

Returns:



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 473

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, :AuthZ]

  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

#get_git_hub_cloud_auth_intake_mapping(intake_mapping_id, opts = {}) ⇒ Object

Get a GitHub cloud authentication intake mapping.

See Also:



532
533
534
535
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 532

def get_git_hub_cloud_auth_intake_mapping(intake_mapping_id, opts = {})
  data, _status_code, _headers = get_git_hub_cloud_auth_intake_mapping_with_http_info(intake_mapping_id, opts)
  data
end

#get_git_hub_cloud_auth_intake_mapping_with_http_info(intake_mapping_id, opts = {}) ⇒ Array<(GitHubCloudAuthIntakeMappingResponse, Integer, Hash)>

Get a GitHub cloud authentication intake mapping.

Get a specific GitHub cloud authentication intake mapping by ID. This endpoint retrieves a single configured intake mapping that entitles a matching GitHub Actions OIDC principal to request Datadog API keys.

Parameters:

  • intake_mapping_id (String) —

    The ID of the intake mapping

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

    the optional parameters

Returns:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 544

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.get_git_hub_cloud_auth_intake_mapping ...'
  end
  # verify the required parameter 'intake_mapping_id' is set
  if @api_client.config.client_side_validation && intake_mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'intake_mapping_id' when calling CloudAuthenticationAPI.get_git_hub_cloud_auth_intake_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/intake_mapping/{intake_mapping_id}'.sub('{intake_mapping_id}', CGI.escape(intake_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] || 'GitHubCloudAuthIntakeMappingResponse'

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

  new_options = opts.merge(
    :operation => :get_git_hub_cloud_auth_intake_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_git_hub_cloud_auth_intake_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a GitHub cloud authentication persona mapping.

See Also:



603
604
605
606
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 603

def get_git_hub_cloud_auth_persona_mapping(persona_mapping_id, opts = {})
  data, _status_code, _headers = get_git_hub_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts)
  data
end

#get_git_hub_cloud_auth_persona_mapping_with_http_info(persona_mapping_id, opts = {}) ⇒ Array<(GitHubCloudAuthPersonaMappingResponse, Integer, Hash)>

Get a GitHub cloud authentication persona mapping.

Get a specific GitHub cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates a GitHub Actions OIDC principal with a Datadog user. The mapped principal can request an impersonation token.

Parameters:

  • persona_mapping_id (String) —

    The ID of the persona mapping

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

    the optional parameters

Returns:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 615

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.get_git_hub_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_git_hub_cloud_auth_persona_mapping"
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/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] || 'GitHubCloudAuthPersonaMappingResponse'

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

  new_options = opts.merge(
    :operation => :get_git_hub_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_git_hub_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:



674
675
676
677
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 674

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:

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

    the optional parameters

Returns:



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 685

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, :AuthZ]

  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

#list_git_hub_cloud_auth_intake_mappings(opts = {}) ⇒ Object

List GitHub cloud authentication intake mappings.

See Also:



740
741
742
743
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 740

def list_git_hub_cloud_auth_intake_mappings(opts = {})
  data, _status_code, _headers = list_git_hub_cloud_auth_intake_mappings_with_http_info(opts)
  data
end

#list_git_hub_cloud_auth_intake_mappings_with_http_info(opts = {}) ⇒ Array<(GitHubCloudAuthIntakeMappingsResponse, Integer, Hash)>

List GitHub cloud authentication intake mappings.

List all GitHub cloud authentication intake mappings. This endpoint retrieves all configured intake mappings that entitle matching GitHub Actions OIDC principals to request Datadog API keys.

Parameters:

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

    the optional parameters

Returns:



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 751

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.list_git_hub_cloud_auth_intake_mappings ...'
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/intake_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] || 'GitHubCloudAuthIntakeMappingsResponse'

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

  new_options = opts.merge(
    :operation => :list_git_hub_cloud_auth_intake_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_git_hub_cloud_auth_intake_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_git_hub_cloud_auth_persona_mappings(opts = {}) ⇒ Object

List GitHub cloud authentication persona mappings.

See Also:



806
807
808
809
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 806

def list_git_hub_cloud_auth_persona_mappings(opts = {})
  data, _status_code, _headers = list_git_hub_cloud_auth_persona_mappings_with_http_info(opts)
  data
end

#list_git_hub_cloud_auth_persona_mappings_with_http_info(opts = {}) ⇒ Array<(GitHubCloudAuthPersonaMappingsResponse, Integer, Hash)>

List GitHub cloud authentication persona mappings.

List all GitHub cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate GitHub Actions OpenID Connect (OIDC) principals with Datadog users. Mapped principals can request impersonation tokens.

Parameters:

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

    the optional parameters

Returns:



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/datadog_api_client/v2/api/cloud_authentication_api.rb', line 817

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAuthenticationAPI.list_git_hub_cloud_auth_persona_mappings ...'
  end
  # resource path
  local_var_path = '/api/v2/cloud_auth/github/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] || 'GitHubCloudAuthPersonaMappingsResponse'

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

  new_options = opts.merge(
    :operation => :list_git_hub_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_git_hub_cloud_auth_persona_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end