Class: Falcon::Mssp

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/mssp.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Mssp

Returns a new instance of Mssp.



35
36
37
 
# File 'lib/crimson-falcon/api/mssp.rb', line 35

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/mssp.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#add_cid_group_members(body, opts = {}) ⇒ DomainCIDGroupMembersResponseV1

Add new CID group member.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both 'cid_group_id' and 'cids' fields are required.

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

    the optional parameters

Returns:



42
43
44
45
 
# File 'lib/crimson-falcon/api/mssp.rb', line 42

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

#add_cid_group_members_with_http_info(body, opts = {}) ⇒ Array<(DomainCIDGroupMembersResponseV1, Integer, Hash)>

Add new CID group member.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both &#39;cid_group_id&#39; and &#39;cids&#39; fields are required.

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

    the optional parameters

Returns:



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
99
100
101
102
 
# File 'lib/crimson-falcon/api/mssp.rb', line 51

def add_cid_group_members_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.add_cid_group_members ...'
  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 Mssp.add_cid_group_members"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-group-members/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#add_role(body, opts = {}) ⇒ DomainMSSPRoleResponseV1

Create a link between user group and CID group, with zero or more additional roles. The call does not replace any existing link between them. User group ID and CID group ID have to be specified in request.

Parameters:

  • body (DomainMSSPRoleRequestV1) —

    &#39;user_group_id&#39;, &#39;cid_group_id&#39; and &#39;role_ids&#39; fields are required. Remaining are populated by system.

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

    the optional parameters

Returns:



108
109
110
111
 
# File 'lib/crimson-falcon/api/mssp.rb', line 108

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

#add_role_with_http_info(body, opts = {}) ⇒ Array<(DomainMSSPRoleResponseV1, Integer, Hash)>

Create a link between user group and CID group, with zero or more additional roles. The call does not replace any existing link between them. User group ID and CID group ID have to be specified in request.

Parameters:

  • body (DomainMSSPRoleRequestV1) —

    &#39;user_group_id&#39;, &#39;cid_group_id&#39; and &#39;role_ids&#39; fields are required. Remaining are populated by system.

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

    the optional parameters

Returns:

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

    DomainMSSPRoleResponseV1 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
166
167
168
 
# File 'lib/crimson-falcon/api/mssp.rb', line 117

def add_role_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.add_role ...'
  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 Mssp.add_role"
  end
  # resource path
  local_var_path = '/mssp/entities/mssp-roles/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#add_user_group_members(body, opts = {}) ⇒ DomainUserGroupMembersResponseV1

Add new user group member. Maximum 500 members allowed per user group.

Parameters:

  • body (DomainUserGroupMembersRequestV1) —

    Both &#39;user_group_id&#39; and &#39;user_uuids&#39; fields are required.

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

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/crimson-falcon/api/mssp.rb', line 174

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

#add_user_group_members_with_http_info(body, opts = {}) ⇒ Array<(DomainUserGroupMembersResponseV1, Integer, Hash)>

Add new user group member. Maximum 500 members allowed per user group.

Parameters:

  • body (DomainUserGroupMembersRequestV1) —

    Both &#39;user_group_id&#39; and &#39;user_uuids&#39; fields are required.

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

    the optional parameters

Returns:



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
231
232
233
234
 
# File 'lib/crimson-falcon/api/mssp.rb', line 183

def add_user_group_members_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.add_user_group_members ...'
  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 Mssp.add_user_group_members"
  end
  # resource path
  local_var_path = '/mssp/entities/user-group-members/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#create_cid_groups(body, opts = {}) ⇒ DomainCIDGroupsResponseV1

Create new CID groups. Name is a required field but description is an optional field. Maximum 500 CID groups allowed.

Parameters:

  • body (DomainCIDGroupsRequestV1) —

    Only &#39;name&#39; and/or &#39;description&#39; fields are required. Remaining are assigned by the system.

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/crimson-falcon/api/mssp.rb', line 240

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

#create_cid_groups_with_http_info(body, opts = {}) ⇒ Array<(DomainCIDGroupsResponseV1, Integer, Hash)>

Create new CID groups. Name is a required field but description is an optional field. Maximum 500 CID groups allowed.

Parameters:

  • body (DomainCIDGroupsRequestV1) —

    Only &#39;name&#39; and/or &#39;description&#39; fields are required. Remaining are assigned by the system.

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

    the optional parameters

Returns:

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

    DomainCIDGroupsResponseV1 data, response status code and response headers



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/crimson-falcon/api/mssp.rb', line 249

def create_cid_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.create_cid_groups ...'
  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 Mssp.create_cid_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-groups/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#create_user_groups(body, opts = {}) ⇒ DomainUserGroupsResponseV1

Create new user groups. Name is a required field but description is an optional field. Maximum 500 user groups allowed per customer.

Parameters:

  • body (DomainUserGroupsRequestV1) —

    Only &#39;name&#39; and/or &#39;description&#39; fields are required. Remaining are assigned by the system.

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

    the optional parameters

Returns:



306
307
308
309
 
# File 'lib/crimson-falcon/api/mssp.rb', line 306

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

#create_user_groups_with_http_info(body, opts = {}) ⇒ Array<(DomainUserGroupsResponseV1, Integer, Hash)>

Create new user groups. Name is a required field but description is an optional field. Maximum 500 user groups allowed per customer.

Parameters:

  • body (DomainUserGroupsRequestV1) —

    Only &#39;name&#39; and/or &#39;description&#39; fields are required. Remaining are assigned by the system.

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

    the optional parameters

Returns:

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

    DomainUserGroupsResponseV1 data, response status code and response headers



315
316
317
318
319
320
321
322
323
324
325
326
327
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
 
# File 'lib/crimson-falcon/api/mssp.rb', line 315

def create_user_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.create_user_groups ...'
  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 Mssp.create_user_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/user-groups/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#delete_cid_group_members(body, opts = {}) ⇒ DomainCIDGroupMembersResponseV1

Deprecated : Please use DELETE /entities/cid-group-members/v2. Delete CID group members.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both &#39;cid_group_id&#39; and &#39;cids&#39; fields are required.

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

    the optional parameters

Returns:



372
373
374
375
 
# File 'lib/crimson-falcon/api/mssp.rb', line 372

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

#delete_cid_group_members_v2(body, opts = {}) ⇒ DomainCIDGroupMembersResponseV1

Delete CID group members. Prevents removal of a cid group a cid group if it is only part of one cid group.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both &#39;cid_group_id&#39; and &#39;cids&#39; fields are required.

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

    the optional parameters

Returns:



438
439
440
441
 
# File 'lib/crimson-falcon/api/mssp.rb', line 438

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

#delete_cid_group_members_v2_with_http_info(body, opts = {}) ⇒ Array<(DomainCIDGroupMembersResponseV1, Integer, Hash)>

Delete CID group members. Prevents removal of a cid group a cid group if it is only part of one cid group.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both &#39;cid_group_id&#39; and &#39;cids&#39; fields are required.

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

    the optional parameters

Returns:



447
448
449
450
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
 
# File 'lib/crimson-falcon/api/mssp.rb', line 447

def delete_cid_group_members_v2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.delete_cid_group_members_v2 ...'
  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 Mssp.delete_cid_group_members_v2"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-group-members/v2'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#delete_cid_group_members_with_http_info(body, opts = {}) ⇒ Array<(DomainCIDGroupMembersResponseV1, Integer, Hash)>

Deprecated : Please use DELETE /entities/cid-group-members/v2. Delete CID group members.

Parameters:

  • body (DomainCIDGroupMembersRequestV1) —

    Both &#39;cid_group_id&#39; and &#39;cids&#39; fields are required.

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

    the optional parameters

Returns:



381
382
383
384
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
 
# File 'lib/crimson-falcon/api/mssp.rb', line 381

def delete_cid_group_members_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.delete_cid_group_members ...'
  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 Mssp.delete_cid_group_members"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-group-members/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#delete_cid_groups(cid_group_ids, opts = {}) ⇒ MsaEntitiesResponse

Delete CID groups by ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group ids to delete

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

    the optional parameters

Returns:



504
505
506
507
 
# File 'lib/crimson-falcon/api/mssp.rb', line 504

def delete_cid_groups(cid_group_ids, opts = {})
  data, _status_code, _headers = delete_cid_groups_with_http_info(cid_group_ids, opts)
  data
end

#delete_cid_groups_with_http_info(cid_group_ids, opts = {}) ⇒ Array<(MsaEntitiesResponse, Integer, Hash)>

Delete CID groups by ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group ids to delete

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

    the optional parameters

Returns:

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

    MsaEntitiesResponse data, response status code and response headers



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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/crimson-falcon/api/mssp.rb', line 513

def delete_cid_groups_with_http_info(cid_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.delete_cid_groups ...'
  end
  # verify the required parameter 'cid_group_ids' is set
  if @api_client.config.client_side_validation && cid_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'cid_group_ids' when calling Mssp.delete_cid_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid_group_ids'] = @api_client.build_collection_param(cid_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#delete_user_group_members(body, opts = {}) ⇒ DomainUserGroupMembersResponseV1

Delete user group members entry.

Parameters:

  • body (DomainUserGroupMembersRequestV1) —

    Both &#39;user_group_id&#39; and &#39;user_uuids&#39; fields are required.

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

    the optional parameters

Returns:



566
567
568
569
 
# File 'lib/crimson-falcon/api/mssp.rb', line 566

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

#delete_user_group_members_with_http_info(body, opts = {}) ⇒ Array<(DomainUserGroupMembersResponseV1, Integer, Hash)>

Delete user group members entry.

Parameters:

  • body (DomainUserGroupMembersRequestV1) —

    Both &#39;user_group_id&#39; and &#39;user_uuids&#39; fields are required.

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

    the optional parameters

Returns:



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
624
625
626
 
# File 'lib/crimson-falcon/api/mssp.rb', line 575

def delete_user_group_members_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.delete_user_group_members ...'
  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 Mssp.delete_user_group_members"
  end
  # resource path
  local_var_path = '/mssp/entities/user-group-members/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#delete_user_groups(user_group_ids, opts = {}) ⇒ MsaEntitiesResponse

Delete user groups by ID.

Parameters:

  • user_group_ids (Array<String>) —

    User group IDs to delete

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

    the optional parameters

Returns:



632
633
634
635
 
# File 'lib/crimson-falcon/api/mssp.rb', line 632

def delete_user_groups(user_group_ids, opts = {})
  data, _status_code, _headers = delete_user_groups_with_http_info(user_group_ids, opts)
  data
end

#delete_user_groups_with_http_info(user_group_ids, opts = {}) ⇒ Array<(MsaEntitiesResponse, Integer, Hash)>

Delete user groups by ID.

Parameters:

  • user_group_ids (Array<String>) —

    User group IDs to delete

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

    the optional parameters

Returns:

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

    MsaEntitiesResponse data, response status code and response headers



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
 
# File 'lib/crimson-falcon/api/mssp.rb', line 641

def delete_user_groups_with_http_info(user_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.delete_user_groups ...'
  end
  # verify the required parameter 'user_group_ids' is set
  if @api_client.config.client_side_validation && user_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_ids' when calling Mssp.delete_user_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_group_ids'] = @api_client.build_collection_param(user_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#deleted_roles(body, opts = {}) ⇒ DomainMSSPRoleResponseV1

Delete links or additional roles between user groups and CID groups. User group ID and CID group ID have to be specified in request. Only specified roles are removed if specified in request payload, else association between User Group and CID group is dissolved completely (if no roles specified).

Parameters:

  • body (DomainMSSPRoleRequestV1) —

    &#39;user_group_id&#39; and &#39;cid_group_id&#39; fields are required. &#39;role_ids&#39; field is optional. Remaining fields are ignored.

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

    the optional parameters

Returns:



694
695
696
697
 
# File 'lib/crimson-falcon/api/mssp.rb', line 694

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

#deleted_roles_with_http_info(body, opts = {}) ⇒ Array<(DomainMSSPRoleResponseV1, Integer, Hash)>

Delete links or additional roles between user groups and CID groups. User group ID and CID group ID have to be specified in request. Only specified roles are removed if specified in request payload, else association between User Group and CID group is dissolved completely (if no roles specified).

Parameters:

  • body (DomainMSSPRoleRequestV1) —

    &#39;user_group_id&#39; and &#39;cid_group_id&#39; fields are required. &#39;role_ids&#39; field is optional. Remaining fields are ignored.

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

    the optional parameters

Returns:

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

    DomainMSSPRoleResponseV1 data, response status code and response headers



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/crimson-falcon/api/mssp.rb', line 703

def deleted_roles_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.deleted_roles ...'
  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 Mssp.deleted_roles"
  end
  # resource path
  local_var_path = '/mssp/entities/mssp-roles/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_children(ids, opts = {}) ⇒ DomainChildrenResponseV1

Get link to child customer by child CID(s)

Parameters:

  • ids (Array<String>) —

    CID of a child customer

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

    the optional parameters

Returns:



760
761
762
763
 
# File 'lib/crimson-falcon/api/mssp.rb', line 760

def get_children(ids, opts = {})
  data, _status_code, _headers = get_children_with_http_info(ids, opts)
  data
end

#get_children_v2(body, opts = {}) ⇒ DomainChildrenResponseV1

Get link to child customer by child CID(s)

Parameters:

Returns:



822
823
824
825
 
# File 'lib/crimson-falcon/api/mssp.rb', line 822

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

#get_children_v2_with_http_info(body, opts = {}) ⇒ Array<(DomainChildrenResponseV1, Integer, Hash)>

Get link to child customer by child CID(s)

Parameters:

Returns:

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

    DomainChildrenResponseV1 data, response status code and response headers



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/crimson-falcon/api/mssp.rb', line 831

def get_children_v2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_children_v2 ...'
  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 Mssp.get_children_v2"
  end
  # resource path
  local_var_path = '/mssp/entities/children/GET/v2'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_children_with_http_info(ids, opts = {}) ⇒ Array<(DomainChildrenResponseV1, Integer, Hash)>

Get link to child customer by child CID(s)

Parameters:

  • ids (Array<String>) —

    CID of a child customer

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

    the optional parameters

Returns:

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

    DomainChildrenResponseV1 data, response status code and response headers



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/crimson-falcon/api/mssp.rb', line 769

def get_children_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_children ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_children"
  end
  # resource path
  local_var_path = '/mssp/entities/children/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_cid_group_by_id(cid_group_ids, opts = {}) ⇒ DomainCIDGroupsResponseV1

Deprecated : Please use GET /mssp/entities/cid-groups/v2. Get CID groups by ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group IDs to be searched on

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

    the optional parameters

Returns:



888
889
890
891
 
# File 'lib/crimson-falcon/api/mssp.rb', line 888

def get_cid_group_by_id(cid_group_ids, opts = {})
  data, _status_code, _headers = get_cid_group_by_id_with_http_info(cid_group_ids, opts)
  data
end

#get_cid_group_by_id_v2(ids, opts = {}) ⇒ DomainCIDGroupsResponseV1

Get CID Groups by ID.

Parameters:

  • ids (Array<String>) —

    CID group IDs to search for

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

    the optional parameters

Returns:



950
951
952
953
 
# File 'lib/crimson-falcon/api/mssp.rb', line 950

def get_cid_group_by_id_v2(ids, opts = {})
  data, _status_code, _headers = get_cid_group_by_id_v2_with_http_info(ids, opts)
  data
end

#get_cid_group_by_id_v2_with_http_info(ids, opts = {}) ⇒ Array<(DomainCIDGroupsResponseV1, Integer, Hash)>

Get CID Groups by ID.

Parameters:

  • ids (Array<String>) —

    CID group IDs to search for

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

    the optional parameters

Returns:

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

    DomainCIDGroupsResponseV1 data, response status code and response headers



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/crimson-falcon/api/mssp.rb', line 959

def get_cid_group_by_id_v2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_cid_group_by_id_v2 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_cid_group_by_id_v2"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-groups/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_cid_group_by_id_with_http_info(cid_group_ids, opts = {}) ⇒ Array<(DomainCIDGroupsResponseV1, Integer, Hash)>

Deprecated : Please use GET /mssp/entities/cid-groups/v2. Get CID groups by ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group IDs to be searched on

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

    the optional parameters

Returns:

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

    DomainCIDGroupsResponseV1 data, response status code and response headers



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/crimson-falcon/api/mssp.rb', line 897

def get_cid_group_by_id_with_http_info(cid_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_cid_group_by_id ...'
  end
  # verify the required parameter 'cid_group_ids' is set
  if @api_client.config.client_side_validation && cid_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'cid_group_ids' when calling Mssp.get_cid_group_by_id"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid_group_ids'] = @api_client.build_collection_param(cid_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_cid_group_members_by(cid_group_ids, opts = {}) ⇒ DomainCIDGroupMembersResponseV1

Deprecated : Please use GET /mssp/entities/cid-group-members/v2. Get CID group members by CID group ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group IDs to search for

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

    the optional parameters

Returns:



1012
1013
1014
1015
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1012

def get_cid_group_members_by(cid_group_ids, opts = {})
  data, _status_code, _headers = get_cid_group_members_by_with_http_info(cid_group_ids, opts)
  data
end

#get_cid_group_members_by_v2(ids, opts = {}) ⇒ DomainCIDGroupMembersResponseV1

Get CID group members by CID Group ID.

Parameters:

  • ids (Array<String>) —

    CID group IDs search for

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

    the optional parameters

Returns:



1074
1075
1076
1077
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1074

def get_cid_group_members_by_v2(ids, opts = {})
  data, _status_code, _headers = get_cid_group_members_by_v2_with_http_info(ids, opts)
  data
end

#get_cid_group_members_by_v2_with_http_info(ids, opts = {}) ⇒ Array<(DomainCIDGroupMembersResponseV1, Integer, Hash)>

Get CID group members by CID Group ID.

Parameters:

  • ids (Array<String>) —

    CID group IDs search for

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

    the optional parameters

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1083

def get_cid_group_members_by_v2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_cid_group_members_by_v2 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_cid_group_members_by_v2"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-group-members/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_cid_group_members_by_with_http_info(cid_group_ids, opts = {}) ⇒ Array<(DomainCIDGroupMembersResponseV1, Integer, Hash)>

Deprecated : Please use GET /mssp/entities/cid-group-members/v2. Get CID group members by CID group ID.

Parameters:

  • cid_group_ids (Array<String>) —

    CID group IDs to search for

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

    the optional parameters

Returns:



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1021

def get_cid_group_members_by_with_http_info(cid_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_cid_group_members_by ...'
  end
  # verify the required parameter 'cid_group_ids' is set
  if @api_client.config.client_side_validation && cid_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'cid_group_ids' when calling Mssp.get_cid_group_members_by"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-group-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid_group_ids'] = @api_client.build_collection_param(cid_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_roles_by_id(ids, opts = {}) ⇒ DomainMSSPRoleResponseV1

Get link between user group and CID group by ID. Link ID is a string consisting of multiple components, but should be treated as opaque.

Parameters:

  • ids (Array<String>) —

    Link ID is a string consisting of multiple components, but should be treated as opaque.

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

    the optional parameters

Returns:



1136
1137
1138
1139
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1136

def get_roles_by_id(ids, opts = {})
  data, _status_code, _headers = get_roles_by_id_with_http_info(ids, opts)
  data
end

#get_roles_by_id_with_http_info(ids, opts = {}) ⇒ Array<(DomainMSSPRoleResponseV1, Integer, Hash)>

Get link between user group and CID group by ID. Link ID is a string consisting of multiple components, but should be treated as opaque.

Parameters:

  • ids (Array<String>) —

    Link ID is a string consisting of multiple components, but should be treated as opaque.

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

    the optional parameters

Returns:

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

    DomainMSSPRoleResponseV1 data, response status code and response headers



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1145

def get_roles_by_id_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_roles_by_id ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_roles_by_id"
  end
  # resource path
  local_var_path = '/mssp/entities/mssp-roles/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_user_group_members_by_id(user_group_ids, opts = {}) ⇒ DomainUserGroupMembersResponseV1

Deprecated : Please use GET /mssp/entities/user-group-members/v2. Get user group members by user group ID.

Parameters:

  • user_group_ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:



1198
1199
1200
1201
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1198

def get_user_group_members_by_id(user_group_ids, opts = {})
  data, _status_code, _headers = get_user_group_members_by_id_with_http_info(user_group_ids, opts)
  data
end

#get_user_group_members_by_id_with_http_info(user_group_ids, opts = {}) ⇒ Array<(DomainUserGroupMembersResponseV1, Integer, Hash)>

Deprecated : Please use GET /mssp/entities/user-group-members/v2. Get user group members by user group ID.

Parameters:

  • user_group_ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1207

def get_user_group_members_by_id_with_http_info(user_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_user_group_members_by_id ...'
  end
  # verify the required parameter 'user_group_ids' is set
  if @api_client.config.client_side_validation && user_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_ids' when calling Mssp.get_user_group_members_by_id"
  end
  # resource path
  local_var_path = '/mssp/entities/user-group-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_group_ids'] = @api_client.build_collection_param(user_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_user_group_members_by_idv2(ids, opts = {}) ⇒ DomainUserGroupMembersResponseV1

Get user group members by user group ID.

Parameters:

  • ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:



1260
1261
1262
1263
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1260

def get_user_group_members_by_idv2(ids, opts = {})
  data, _status_code, _headers = get_user_group_members_by_idv2_with_http_info(ids, opts)
  data
end

#get_user_group_members_by_idv2_with_http_info(ids, opts = {}) ⇒ Array<(DomainUserGroupMembersResponseV1, Integer, Hash)>

Get user group members by user group ID.

Parameters:

  • ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1269

def get_user_group_members_by_idv2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_user_group_members_by_idv2 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_user_group_members_by_idv2"
  end
  # resource path
  local_var_path = '/mssp/entities/user-group-members/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_user_groups_by_id(user_group_ids, opts = {}) ⇒ DomainUserGroupsResponseV1

Deprecated : Please use GET /entities/user-groups/v2. Get user groups by ID.

Parameters:

  • user_group_ids (Array<String>) —

    User Group IDs to search for

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

    the optional parameters

Returns:



1322
1323
1324
1325
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1322

def get_user_groups_by_id(user_group_ids, opts = {})
  data, _status_code, _headers = get_user_groups_by_id_with_http_info(user_group_ids, opts)
  data
end

#get_user_groups_by_id_with_http_info(user_group_ids, opts = {}) ⇒ Array<(DomainUserGroupsResponseV1, Integer, Hash)>

Deprecated : Please use GET /entities/user-groups/v2. Get user groups by ID.

Parameters:

  • user_group_ids (Array<String>) —

    User Group IDs to search for

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

    the optional parameters

Returns:

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

    DomainUserGroupsResponseV1 data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1331

def get_user_groups_by_id_with_http_info(user_group_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_user_groups_by_id ...'
  end
  # verify the required parameter 'user_group_ids' is set
  if @api_client.config.client_side_validation && user_group_ids.nil?
    fail ArgumentError, "Missing the required parameter 'user_group_ids' when calling Mssp.get_user_groups_by_id"
  end
  # resource path
  local_var_path = '/mssp/entities/user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_group_ids'] = @api_client.build_collection_param(user_group_ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#get_user_groups_by_idv2(ids, opts = {}) ⇒ DomainUserGroupsResponseV1

Get user groups by ID.

Parameters:

  • ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:



1384
1385
1386
1387
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1384

def get_user_groups_by_idv2(ids, opts = {})
  data, _status_code, _headers = get_user_groups_by_idv2_with_http_info(ids, opts)
  data
end

#get_user_groups_by_idv2_with_http_info(ids, opts = {}) ⇒ Array<(DomainUserGroupsResponseV1, Integer, Hash)>

Get user groups by ID.

Parameters:

  • ids (Array<String>) —

    User group IDs to search for

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

    the optional parameters

Returns:

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

    DomainUserGroupsResponseV1 data, response status code and response headers



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1393

def get_user_groups_by_idv2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.get_user_groups_by_idv2 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling Mssp.get_user_groups_by_idv2"
  end
  # resource path
  local_var_path = '/mssp/entities/user-groups/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_children(opts = {}) ⇒ MsaspecQueryResponse

Query for customers linked as children

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filters: cid

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Number of ids to return (default to 10)

Returns:



1449
1450
1451
1452
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1449

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

#query_children_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Query for customers linked as children

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filters: cid

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Number of ids to return (default to 10)

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1461

def query_children_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_children ...'
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/children/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaspecQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_cid_group_members(cid, opts = {}) ⇒ MsaQueryResponse

Query a CID groups members by associated CID.

Parameters:

  • cid (String) —

    CID to lookup associated CID group ID

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return id (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:



1520
1521
1522
1523
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1520

def query_cid_group_members(cid, opts = {})
  data, _status_code, _headers = query_cid_group_members_with_http_info(cid, opts)
  data
end

#query_cid_group_members_with_http_info(cid, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Query a CID groups members by associated CID.

Parameters:

  • cid (String) —

    CID to lookup associated CID group ID

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return id (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:

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

    MsaQueryResponse data, response status code and response headers



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1532

def query_cid_group_members_with_http_info(cid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_cid_group_members ...'
  end
  # verify the required parameter 'cid' is set
  if @api_client.config.client_side_validation && cid.nil?
    fail ArgumentError, "Missing the required parameter 'cid' when calling Mssp.query_cid_group_members"
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/cid-group-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid'] = cid
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_cid_groups(opts = {}) ⇒ MsaQueryResponse

Query CID groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to lookup groups for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘name|asc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:



1595
1596
1597
1598
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1595

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

#query_cid_groups_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Query CID groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to lookup groups for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘name|asc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:

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

    MsaQueryResponse data, response status code and response headers



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1607

def query_cid_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_cid_groups ...'
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc", "name|asc", "name|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/cid-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_roles(opts = {}) ⇒ MsaQueryResponse

Query links between user groups and CID groups. At least one of CID group ID or user group ID should also be provided. Role ID is optional.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_group_id (String) —

    User group ID to fetch MSSP role for

  • :cid_group_id (String) —

    CID group ID to fetch MSSP role for

  • :role_id (String) —

    Role ID to fetch MSSP role for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:



1668
1669
1670
1671
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1668

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

#query_roles_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Query links between user groups and CID groups. At least one of CID group ID or user group ID should also be provided. Role ID is optional.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_group_id (String) —

    User group ID to fetch MSSP role for

  • :cid_group_id (String) —

    CID group ID to fetch MSSP role for

  • :role_id (String) —

    Role ID to fetch MSSP role for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:

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

    MsaQueryResponse data, response status code and response headers



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1682

def query_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_roles ...'
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/mssp-roles/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_group_id'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'cid_group_id'] = opts[:'cid_group_id'] if !opts[:'cid_group_id'].nil?
  query_params[:'role_id'] = opts[:'role_id'] if !opts[:'role_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_user_group_members(user_uuid, opts = {}) ⇒ MsaQueryResponse

Query user group member by user UUID.

Parameters:

  • user_uuid (String) —

    User UUID to lookup associated user group ID

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Number of ids to return (default to 10)

Returns:



1743
1744
1745
1746
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1743

def query_user_group_members(user_uuid, opts = {})
  data, _status_code, _headers = query_user_group_members_with_http_info(user_uuid, opts)
  data
end

#query_user_group_members_with_http_info(user_uuid, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Query user group member by user UUID.

Parameters:

  • user_uuid (String) —

    User UUID to lookup associated user group ID

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The sort expression used to sort the results (default to ‘last_modified_timestamp|desc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Number of ids to return (default to 10)

Returns:

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

    MsaQueryResponse data, response status code and response headers



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1755

def query_user_group_members_with_http_info(user_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_user_group_members ...'
  end
  # verify the required parameter 'user_uuid' is set
  if @api_client.config.client_side_validation && user_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'user_uuid' when calling Mssp.query_user_group_members"
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/user-group-members/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_uuid'] = user_uuid
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#query_user_groups(opts = {}) ⇒ MsaQueryResponse

Query user groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to lookup groups for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘name|asc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:



1818
1819
1820
1821
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1818

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

#query_user_groups_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Query user groups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name to lookup groups for

  • :sort (String) —

    The sort expression used to sort the results (default to ‘name|asc’)

  • :offset (Integer) —

    Starting index of overall result set from which to return ids (default to 0)

  • :limit (Integer) —

    Maximum number of results to return (default to 10)

Returns:

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

    MsaQueryResponse data, response status code and response headers



1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1830

def query_user_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.query_user_groups ...'
  end
  allowable_values = ["last_modified_timestamp|asc", "last_modified_timestamp|desc", "name|asc", "name|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/mssp/queries/user-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'MsaQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#update_cid_groups(body, opts = {}) ⇒ DomainCIDGroupsResponseV1

Update existing CID groups. CID group ID is expected for each CID group definition provided in request body. Name is a required field but description is an optional field. Empty description will override existing value. CID group member(s) remain unaffected.

Parameters:

  • body (DomainCIDGroupsRequestV1) —

    &#39;cid_group_id&#39; field is required to identify the CID group to update along with &#39;name&#39; and/or &#39;description&#39; fields to be updated.

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

    the optional parameters

Returns:



1886
1887
1888
1889
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1886

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

#update_cid_groups_with_http_info(body, opts = {}) ⇒ Array<(DomainCIDGroupsResponseV1, Integer, Hash)>

Update existing CID groups. CID group ID is expected for each CID group definition provided in request body. Name is a required field but description is an optional field. Empty description will override existing value. CID group member(s) remain unaffected.

Parameters:

  • body (DomainCIDGroupsRequestV1) —

    &#39;cid_group_id&#39; field is required to identify the CID group to update along with &#39;name&#39; and/or &#39;description&#39; fields to be updated.

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

    the optional parameters

Returns:

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

    DomainCIDGroupsResponseV1 data, response status code and response headers



1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1895

def update_cid_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.update_cid_groups ...'
  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 Mssp.update_cid_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/cid-groups/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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

#update_user_groups(body, opts = {}) ⇒ DomainUserGroupsResponseV1

Update existing user group(s). User group ID is expected for each user group definition provided in request body. Name is a required field but description is an optional field. Empty description will override existing value. User group member(s) remain unaffected.

Parameters:

  • body (DomainUserGroupsRequestV1) —

    &#39;user_group_id&#39; field is required to identify the user group to update along with &#39;name&#39; and/or &#39;description&#39; fields to be updated.

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

    the optional parameters

Returns:



1952
1953
1954
1955
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1952

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

#update_user_groups_with_http_info(body, opts = {}) ⇒ Array<(DomainUserGroupsResponseV1, Integer, Hash)>

Update existing user group(s). User group ID is expected for each user group definition provided in request body. Name is a required field but description is an optional field. Empty description will override existing value. User group member(s) remain unaffected.

Parameters:

  • body (DomainUserGroupsRequestV1) —

    &#39;user_group_id&#39; field is required to identify the user group to update along with &#39;name&#39; and/or &#39;description&#39; fields to be updated.

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

    the optional parameters

Returns:

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

    DomainUserGroupsResponseV1 data, response status code and response headers



1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/crimson-falcon/api/mssp.rb', line 1961

def update_user_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Mssp.update_user_groups ...'
  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 Mssp.update_user_groups"
  end
  # resource path
  local_var_path = '/mssp/entities/user-groups/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

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