Class: DatadogAPIClient::V1::OrganizationsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/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/v1/api/organizations_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/organizations_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create a child organization.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 30

def create_child_org(body, opts = {})
  data, _status_code, _headers = create_child_org_with_http_info(body, opts)
  data
end

#create_child_org_with_http_info(body, opts = {}) ⇒ Array<(OrganizationCreateResponse, Integer, Hash)>

Create a child organization.

Create a child organization.

This endpoint requires the multi-organization account feature and must be enabled by contacting support.

Once a new child organization is created, you can interact with it by using the org.public_id, api_key.key, and application_key.hash provided in the response.

Parameters:

  • body (OrganizationCreateBody) —

    Organization object that needs to be created

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

    the optional parameters

Returns:

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

    OrganizationCreateResponse data, response status code and response headers



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
91
92
93
94
95
96
97
98
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 40

def create_child_org_with_http_info(body, opts = {})

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

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

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

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

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

#downgrade_org(public_id, opts = {}) ⇒ Object

Spin-off Child Organization.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 105

def downgrade_org(public_id, opts = {})
  data, _status_code, _headers = downgrade_org_with_http_info(public_id, opts)
  data
end

#downgrade_org_with_http_info(public_id, opts = {}) ⇒ Array<(OrgDowngradedResponse, Integer, Hash)>

Spin-off Child Organization.

Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial.

Parameters:

  • public_id (String) —

    The public_id of the organization you are operating within.

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

    the optional parameters

Returns:

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

    OrgDowngradedResponse data, response status code and response headers



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

def downgrade_org_with_http_info(public_id, opts = {})

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

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

  new_options = opts.merge(
    :operation => :downgrade_org,
    :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 => "V1"
  )

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

#get_org(public_id, opts = {}) ⇒ Object

Get organization information.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 105

def get_org(public_id, opts = {})
  data, _status_code, _headers = get_org_with_http_info(public_id, opts)
  data
end

#get_org_with_http_info(public_id, opts = {}) ⇒ Array<(OrganizationResponse, Integer, Hash)>

Get organization information.

Get organization information.

Parameters:

  • public_id (String) —

    The public_id of the organization you are operating within.

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

    the optional parameters

Returns:

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

    OrganizationResponse data, response status code and response headers



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

def get_org_with_http_info(public_id, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.get_org ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling OrganizationsAPI.get_org"
  end
  # resource path
  local_var_path = '/api/v1/org/{public_id}'.sub('{' + 'public_id' + '}', CGI.escape(public_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :get_org,
    :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: OrganizationsAPI#get_org\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:



177
178
179
180
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 177

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

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

List your managed organizations.

This endpoint returns data on your top-level organization.

Parameters:

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

    the optional parameters

Returns:

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

    OrganizationListResponse data, response status code and response headers



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

def list_orgs_with_http_info(opts = {})

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

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

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

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

  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
  )

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

#update_org(public_id, body, opts = {}) ⇒ Object

Update your organization.

See Also:



246
247
248
249
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 246

def update_org(public_id, body, opts = {})
  data, _status_code, _headers = update_org_with_http_info(public_id, body, opts)
  data
end

#update_org_with_http_info(public_id, body, opts = {}) ⇒ Array<(OrganizationResponse, Integer, Hash)>

Update your organization.

Update your organization.

Parameters:

  • public_id (String) —

    The public_id of the organization you are operating within.

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

    the optional parameters

Returns:

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

    OrganizationResponse data, response status code and response headers



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 257

def update_org_with_http_info(public_id, body, opts = {})

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

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

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

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

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

#upload_id_p_for_org(public_id, idp_file, opts = {}) ⇒ IdpResponse

Upload IdP metadata There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. * Multipart Form-Data: Post the IdP metadata file using a form post. * XML Body: Post the IdP metadata file as the body of the request.

Parameters:

  • public_id (String) —

    The `public_id` of the organization you are operating with

  • idp_file (File) —

    The path to the XML metadata file you wish to upload.

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

    the optional parameters

Returns:



327
328
329
330
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 327

def upload_id_p_for_org(public_id, idp_file, opts = {})
  data, _status_code, _headers = upload_id_p_for_org_with_http_info(public_id, idp_file, opts)
  data
end

#upload_id_p_for_org_with_http_info(public_id, idp_file, opts = {}) ⇒ Array<(IdpResponse, Integer, Hash)>

Upload IdP metadata There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. * Multipart Form-Data: Post the IdP metadata file using a form post. * XML Body: Post the IdP metadata file as the body of the request.

Parameters:

  • public_id (String) —

    The `public_id` of the organization you are operating with

  • idp_file (File) —

    The path to the XML metadata file you wish to upload.

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

    the optional parameters

Returns:

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

    IdpResponse data, response status code and response headers



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

def upload_id_p_for_org_with_http_info(public_id, idp_file, opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsAPI.upload_id_p_for_org ...'
  end
  # verify the required parameter 'public_id' is set
  if @api_client.config.client_side_validation && public_id.nil?
    fail ArgumentError, "Missing the required parameter 'public_id' when calling OrganizationsAPI.upload_id_p_for_org"
  end
  # verify the required parameter 'idp_file' is set
  if @api_client.config.client_side_validation && idp_file.nil?
    fail ArgumentError, "Missing the required parameter 'idp_file' when calling OrganizationsAPI.upload_id_p_for_org"
  end
  # resource path
  local_var_path = '/api/v1/org/{public_id}/idp_metadata'.sub('{' + 'public_id' + '}', CGI.escape(public_id.to_s))

  # 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(['multipart/form-data'])

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

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

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

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

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

#upload_idp_for_org(public_id, idp_file, opts = {}) ⇒ Object

Upload IdP metadata.

See Also:



367
368
369
370
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 367

def upload_idp_for_org(public_id, idp_file, opts = {})
  data, _status_code, _headers = upload_idp_for_org_with_http_info(public_id, idp_file, opts)
  data
end

#upload_idp_for_org_with_http_info(public_id, idp_file, opts = {}) ⇒ Array<(IdpResponse, Integer, Hash)>

Upload IdP metadata.

There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP.

  • Multipart Form-Data: Post the IdP metadata file using a form post.

  • XML Body: Post the IdP metadata file as the body of the request.

Parameters:

  • public_id (String) —

    The public_id of the organization you are operating with

  • idp_file (File) —

    The path to the XML metadata file you wish to upload.

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

    the optional parameters

Returns:

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

    IdpResponse data, response status code and response headers



385
386
387
388
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
434
435
436
437
438
439
440
 
# File 'lib/datadog_api_client/v1/api/organizations_api.rb', line 385

def upload_idp_for_org_with_http_info(public_id, idp_file, opts = {})

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

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

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

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

  new_options = opts.merge(
    :operation => :upload_idp_for_org,
    :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 => "V1"
  )

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