Class: DatadogAPIClient::V2::OrganizationsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OrganizationsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/organizations_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/organizations_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_org_config(org_config_name, opts = {}) ⇒ Object

Get a specific Org Config value.

See Also:



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

def get_org_config(org_config_name, opts = {})
  data, _status_code, _headers = get_org_config_with_http_info(org_config_name, opts)
  data
end

#get_org_config_with_http_info(org_config_name, opts = {}) ⇒ Array<(OrgConfigGetResponse, Integer, Hash)>

Get a specific Org Config value.

Return the name, description, and value of a specific Org Config.

Parameters:

  • org_config_name (String) —

    The name of an Org Config.

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

    the optional parameters

Returns:

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

    OrgConfigGetResponse 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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 41

def get_org_config_with_http_info(org_config_name, opts = {})

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

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

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

#get_saml_configuration(saml_config_uuid, opts = {}) ⇒ Object

Get a SAML configuration.

See Also:



94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 94

def get_saml_configuration(saml_config_uuid, opts = {})
  data, _status_code, _headers = get_saml_configuration_with_http_info(saml_config_uuid, opts)
  data
end

#get_saml_configuration_with_http_info(saml_config_uuid, opts = {}) ⇒ Array<(SAMLConfigurationResponse, Integer, Hash)>

Get a SAML configuration.

Get a single SAML configuration for the current organization by its UUID.

Parameters:

  • saml_config_uuid (String) —

    The UUID of the SAML configuration.

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

    the optional parameters

Returns:

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

    SAMLConfigurationResponse data, response status code and response headers



106
107
108
109
110
111
112
113
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 106

def get_saml_configuration_with_http_info(saml_config_uuid, opts = {})

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

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

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

#list_global_orgs(user_handle, opts = {}) ⇒ Object

List global orgs.

See Also:



159
160
161
162
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 159

def list_global_orgs(user_handle, opts = {})
  data, _status_code, _headers = list_global_orgs_with_http_info(user_handle, opts)
  data
end

#list_global_orgs_with_http_info(user_handle, opts = {}) ⇒ Array<(GlobalOrgsResponse, Integer, Hash)>

List global orgs.

Returns organizations across regions for the authenticated user. The user_handle query parameter must match the authenticated user's handle.

Parameters:

  • user_handle (String) —

    The handle of the authenticated user.

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

    the optional parameters

Options Hash (opts):

  • :page_limit (Integer) —

    Maximum number of results returned.

  • :page_cursor (String) —

    String to query the next page of results. This key is provided with each valid response from the API in meta.page.next_cursor.

Returns:

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

    GlobalOrgsResponse data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 173

def list_global_orgs_with_http_info(user_handle, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.list_global_orgs ...'
  end
  # verify the required parameter 'user_handle' is set
  if @api_client.config.client_side_validation && user_handle.nil?
    fail ArgumentError, "Missing the required parameter 'user_handle' when calling OrganizationsAPI.list_global_orgs"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling OrganizationsAPI.list_global_orgs, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling OrganizationsAPI.list_global_orgs, must be greater than or equal to 1.'
  end
  # resource path
  local_var_path = '/api/v2/global_orgs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_handle'] = user_handle
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

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

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

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

#list_global_orgs_with_pagination(user_handle, opts = {}) {|GlobalOrgData| ... } ⇒ Object

List global orgs.

Provide a paginated version of #list_global_orgs, returning all items.

To use it you need to use a block: list_global_orgs_with_pagination { |item| p item }

Yields:



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 239

def list_global_orgs_with_pagination(user_handle, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 100)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_global_orgs(user_handle, opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length == 0
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.next_cursor"))
    end
end

#list_org_configs(opts = {}) ⇒ Object

List Org Configs.

See Also:



256
257
258
259
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 256

def list_org_configs(opts = {})
  data, _status_code, _headers = list_org_configs_with_http_info(opts)
  data
end

#list_org_configs_with_http_info(opts = {}) ⇒ Array<(OrgConfigListResponse, Integer, Hash)>

List Org Configs.

Returns all Org Configs (name, description, and value).

Parameters:

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

    the optional parameters

Returns:

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

    OrgConfigListResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 267

def list_org_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.list_org_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/org_configs'

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

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

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

#list_orgs(opts = {}) ⇒ Object

List your managed organizations.

See Also:



316
317
318
319
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 316

def list_orgs(opts = {})
  data, _status_code, _headers = list_orgs_with_http_info(opts)
  data
end

#list_orgs_with_http_info(opts = {}) ⇒ Array<(ManagedOrgsResponse, Integer, Hash)>

List your managed organizations.

Returns the current organization and its managed organizations in JSON:API format.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_name (String) —

    Filter managed organizations by name.

Returns:

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

    ManagedOrgsResponse data, response status code and response headers



328
329
330
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 328

def list_orgs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.list_orgs ...'
  end
  # resource path
  local_var_path = '/api/v2/org'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?

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

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

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

#list_saml_configurations(opts = {}) ⇒ Object

List SAML configurations.

See Also:



378
379
380
381
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 378

def list_saml_configurations(opts = {})
  data, _status_code, _headers = list_saml_configurations_with_http_info(opts)
  data
end

#list_saml_configurations_with_http_info(opts = {}) ⇒ Array<(SAMLConfigurationsResponse, Integer, Hash)>

List SAML configurations.

Get the list of SAML configurations for the current organization. An organization has at most one SAML configuration.

Parameters:

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

    the optional parameters

Returns:

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

    SAMLConfigurationsResponse data, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 389

def list_saml_configurations_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.list_saml_configurations ...'
  end
  # resource path
  local_var_path = '/api/v2/saml_configurations'

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

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

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

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

Update the maximum session duration.

See Also:



438
439
440
441
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 438

def (body, opts = {})
  (body, opts)
  nil
end

#update_login_org_configs_max_session_duration_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update the maximum session duration.

Update the maximum session duration for the current organization. The duration is specified in seconds.

Parameters:

Returns:

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

    nil, response status code and response headers



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 451

def (body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.update_login_org_configs_max_session_duration ...'
  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 OrganizationsAPI.update_login_org_configs_max_session_duration"
  end
  # resource path
  local_var_path = '/api/v2/login/org_configs/max_session_duration'

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

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

  new_options = opts.merge(
    :operation => :update_login_org_configs_max_session_duration,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsAPI#update_login_org_configs_max_session_duration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_org_config(org_config_name, body, opts = {}) ⇒ Object

Update a specific Org Config.

See Also:



506
507
508
509
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 506

def update_org_config(org_config_name, body, opts = {})
  data, _status_code, _headers = update_org_config_with_http_info(org_config_name, body, opts)
  data
end

#update_org_config_with_http_info(org_config_name, body, opts = {}) ⇒ Array<(OrgConfigGetResponse, Integer, Hash)>

Update a specific Org Config.

Update the value of a specific Org Config.

Parameters:

  • org_config_name (String) —

    The name of an Org Config.

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

    the optional parameters

Returns:

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

    OrgConfigGetResponse data, response status code and response headers



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 519

def update_org_config_with_http_info(org_config_name, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.update_org_config ...'
  end
  # verify the required parameter 'org_config_name' is set
  if @api_client.config.client_side_validation && org_config_name.nil?
    fail ArgumentError, "Missing the required parameter 'org_config_name' when calling OrganizationsAPI.update_org_config"
  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 OrganizationsAPI.update_org_config"
  end
  # resource path
  local_var_path = '/api/v2/org_configs/{org_config_name}'.sub('{org_config_name}', CGI.escape(org_config_name.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'])
  # 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] || 'OrgConfigGetResponse'

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

  new_options = opts.merge(
    :operation => :update_org_config,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsAPI#update_org_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update organization SAML preferences.

See Also:



578
579
580
581
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 578

def update_org_saml_configurations(body, opts = {})
  update_org_saml_configurations_with_http_info(body, opts)
  nil
end

#update_org_saml_configurations_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update organization SAML preferences.

Update the SAML preferences for the current organization.

Use this endpoint to set the just-in-time (JIT) provisioning domains and the default role assigned to just-in-time provisioned users.

Parameters:

Returns:

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

    nil, response status code and response headers



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 593

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.update_org_saml_configurations ...'
  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 OrganizationsAPI.update_org_saml_configurations"
  end
  # resource path
  local_var_path = '/api/v2/org/saml_configurations'

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

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

  new_options = opts.merge(
    :operation => :update_org_saml_configurations,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsAPI#update_org_saml_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_saml_configuration(saml_config_uuid, body, opts = {}) ⇒ Object

Update a SAML configuration.

See Also:



654
655
656
657
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 654

def update_saml_configuration(saml_config_uuid, body, opts = {})
  data, _status_code, _headers = update_saml_configuration_with_http_info(saml_config_uuid, body, opts)
  data
end

#update_saml_configuration_with_http_info(saml_config_uuid, body, opts = {}) ⇒ Array<(SAMLConfigurationResponse, Integer, Hash)>

Update a SAML configuration.

Update a single SAML configuration for the current organization.

Use this endpoint to enable or disable identity-provider-initiated login, set the just-in-time provisioning domains, and set the default role assigned to just-in-time provisioned users. A default role is required to enable just-in-time provisioning.

Parameters:

  • saml_config_uuid (String) —

    The UUID of the SAML configuration.

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

    the optional parameters

Returns:

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

    SAMLConfigurationResponse data, response status code and response headers



671
672
673
674
675
676
677
678
679
680
681
682
683
684
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 671

def update_saml_configuration_with_http_info(saml_config_uuid, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.update_saml_configuration ...'
  end
  # verify the required parameter 'saml_config_uuid' is set
  if @api_client.config.client_side_validation && saml_config_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'saml_config_uuid' when calling OrganizationsAPI.update_saml_configuration"
  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 OrganizationsAPI.update_saml_configuration"
  end
  # resource path
  local_var_path = '/api/v2/saml_configurations/{saml_config_uuid}'.sub('{saml_config_uuid}', CGI.escape(saml_config_uuid.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'])
  # 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] || 'SAMLConfigurationResponse'

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

  new_options = opts.merge(
    :operation => :update_saml_configuration,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsAPI#update_saml_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_idp_metadata(opts = {}) ⇒ Object

Upload IdP metadata.

See Also:



730
731
732
733
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 730

def upload_idp_metadata(opts = {})
  upload_idp_metadata_with_http_info(opts)
  nil
end

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

Upload IdP metadata.

Endpoint for uploading IdP metadata for SAML setup.

Use this endpoint to upload or replace IdP metadata for SAML login configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idp_file (File) —

    The IdP metadata XML file

Returns:

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

    nil, response status code and response headers



744
745
746
747
748
749
750
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
 
# File 'lib/datadog_api_client/v2/api/organizations_api.rb', line 744

def upload_idp_metadata_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.upload_idp_metadata ...'
  end
  # resource path
  local_var_path = '/api/v2/saml_configurations/idp_metadata'

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

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['idp_file'] = opts[:'idp_file'] if !opts[:'idp_file'].nil?

  # 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 => :upload_idp_metadata,
    :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: OrganizationsAPI#upload_idp_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end