Class: DatadogAPIClient::V2::UsersAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of UsersAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_service_account(body, opts = {}) ⇒ UserResponse

Create a service account Create a service account for your organization.

Parameters:

Returns:



30
31
32
33
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 30

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

#create_service_account_with_http_info(body, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Create a service account Create a service account for your organization.

Parameters:

Returns:

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

    UserResponse 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/v2/api/users_api.rb', line 40

def (body, opts = {})

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

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

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

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

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

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

Create a user.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 105

def create_user(body, opts = {})
  data, _status_code, _headers = create_user_with_http_info(body, opts)
  data
end

#create_user_with_http_info(body, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Create a user.

Create a user for your organization.

Parameters:

Returns:

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

    UserResponse 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
172
173
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 115

def create_user_with_http_info(body, opts = {})

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

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

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

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

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

#disable_user(user_id, opts = {}) ⇒ Object

Disable a user.

See Also:



180
181
182
183
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 180

def disable_user(user_id, opts = {})
  disable_user_with_http_info(user_id, opts)
  nil
end

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

Disable a user.

Disable a user. Can only be used with an application key belonging to an administrator user.

Parameters:

  • user_id (String) —

    The ID of the user.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
244
245
246
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 190

def disable_user_with_http_info(user_id, opts = {})

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

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

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

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

#get_invitation(user_invitation_uuid, opts = {}) ⇒ Object

Get a user invitation.

See Also:



253
254
255
256
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 253

def get_invitation(user_invitation_uuid, opts = {})
  data, _status_code, _headers = get_invitation_with_http_info(user_invitation_uuid, opts)
  data
end

#get_invitation_with_http_info(user_invitation_uuid, opts = {}) ⇒ Array<(UserInvitationResponse, Integer, Hash)>

Get a user invitation.

Returns a single user invitation by its UUID.

Parameters:

  • user_invitation_uuid (String) —

    The UUID of the user invitation.

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

    the optional parameters

Returns:

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

    UserInvitationResponse data, response status code and response headers



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/v2/api/users_api.rb', line 263

def get_invitation_with_http_info(user_invitation_uuid, opts = {})

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

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

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

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

#get_user(user_id, opts = {}) ⇒ Object

Get user details.

See Also:



326
327
328
329
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 326

def get_user(user_id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(user_id, opts)
  data
end

#get_user_with_http_info(user_id, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Get user details.

Get a user in the organization specified by the user’s user_id.

Parameters:

  • user_id (String) —

    The ID of the user.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
386
387
388
389
390
391
392
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 336

def get_user_with_http_info(user_id, opts = {})

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

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

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

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

#list_user_organizations(user_id, opts = {}) ⇒ Object

Get a user organization.

See Also:



399
400
401
402
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 399

def list_user_organizations(user_id, opts = {})
  data, _status_code, _headers = list_user_organizations_with_http_info(user_id, opts)
  data
end

#list_user_organizations_with_http_info(user_id, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Get a user organization.

Get a user organization. Returns the user information and all organizations joined by this user.

Parameters:

  • user_id (String) —

    The ID of the user.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



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
457
458
459
460
461
462
463
464
465
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 409

def list_user_organizations_with_http_info(user_id, opts = {})

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

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

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

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

#list_user_permissions(user_id, opts = {}) ⇒ Object

Get a user permissions.

See Also:



472
473
474
475
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 472

def list_user_permissions(user_id, opts = {})
  data, _status_code, _headers = list_user_permissions_with_http_info(user_id, opts)
  data
end

#list_user_permissions_with_http_info(user_id, opts = {}) ⇒ Array<(PermissionsResponse, Integer, Hash)>

Get a user permissions.

Get a user permission set. Returns a list of the user’s permissions granted by the associated user's roles.

Parameters:

  • user_id (String) —

    The ID of the user.

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

    the optional parameters

Returns:

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

    PermissionsResponse data, response status code and response headers



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
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 482

def list_user_permissions_with_http_info(user_id, opts = {})

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

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

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

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

#list_users(opts = {}) ⇒ Object

List all users.

See Also:



550
551
552
553
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 550

def list_users(opts = {})
  data, _status_code, _headers = list_users_with_http_info(opts)
  data
end

#list_users_with_http_info(opts = {}) ⇒ Array<(UsersResponse, Integer, Hash)>

List all users.

Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_number (Integer) —

    Specific page number to return.

  • :sort (String) —

    User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example sort=-name. Options: name, modified_at, user_count.

  • :sort_dir (QuerySortOrder) —

    Direction of sort. Options: asc, desc.

  • :filter (String) —

    Filter all users by the given string. Defaults to no filtering.

  • :filter_status (String) —

    Filter on status attribute. Comma separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.

Returns:

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

    UsersResponse data, response status code and response headers



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

def list_users_with_http_info(opts = {})

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersAPI.list_users ...'
  end
  # resource path
  local_var_path = '/api/v2/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].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] || 'UsersResponse'

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

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

#list_users_with_pagination(opts = {}) {|User| ... } ⇒ Object

List all users.

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

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

Yields:

  • (User) —

    Paginated items



505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 505

def list_users_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
    @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, 0)
    while true do
        response = list_users(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, @api_client.get_attribute_from_path(opts, "page_number", 0) + 1)
    end
end

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

Send invitation emails.

See Also:



630
631
632
633
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 630

def send_invitations(body, opts = {})
  data, _status_code, _headers = send_invitations_with_http_info(body, opts)
  data
end

#send_invitations_with_http_info(body, opts = {}) ⇒ Array<(UserInvitationsResponse, Integer, Hash)>

Send invitation emails.

Sends emails to one or more users inviting them to join the organization.

Parameters:

Returns:

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

    UserInvitationsResponse data, response status code and response headers



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

def send_invitations_with_http_info(body, opts = {})

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

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

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

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

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

#update_user(user_id, body, opts = {}) ⇒ Object

Update a user.

See Also:



706
707
708
709
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 706

def update_user(user_id, body, opts = {})
  data, _status_code, _headers = update_user_with_http_info(user_id, body, opts)
  data
end

#update_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(UserResponse, Integer, Hash)>

Update a user.

Edit a user. Can only be used with an application key belonging to an administrator user.

Parameters:

  • user_id (String) —

    The ID of the user.

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

    the optional parameters

Returns:

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

    UserResponse data, response status code and response headers



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
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
 
# File 'lib/datadog_api_client/v2/api/users_api.rb', line 717

def update_user_with_http_info(user_id, body, opts = {})

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

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

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

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