Class: Falcon::CloudPolicies

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudPolicies

Returns a new instance of CloudPolicies.



35
36
37
 
# File 'lib/crimson-falcon/api/cloud_policies.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/cloud_policies.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#clone_compliance_framework(ids, opts = {}) ⇒ CommonCreateComplianceFrameworkResponse

Clone an existing compliance framework to create a custom copy

Parameters:

  • ids (String) —

    The uuid of the compliance framework to clone

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

    the optional parameters

Returns:



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

def clone_compliance_framework(ids, opts = {})
  data, _status_code, _headers = clone_compliance_framework_with_http_info(ids, opts)
  data
end

#clone_compliance_framework_with_http_info(ids, opts = {}) ⇒ Array<(CommonCreateComplianceFrameworkResponse, Integer, Hash)>

Clone an existing compliance framework to create a custom copy

Parameters:

  • ids (String) —

    The uuid of the compliance framework to clone

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

def clone_compliance_framework_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.clone_compliance_framework ...'
  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 CloudPolicies.clone_compliance_framework"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/clone-framework/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

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

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

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

#create_compliance_control(body, opts = {}) ⇒ CommonCreateComplianceControlResponse

Create a new custom compliance control

Parameters:

Returns:



104
105
106
107
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 104

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

#create_compliance_control_with_http_info(body, opts = {}) ⇒ Array<(CommonCreateComplianceControlResponse, Integer, Hash)>

Create a new custom compliance control

Parameters:

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 113

def create_compliance_control_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.create_compliance_control ...'
  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 CloudPolicies.create_compliance_control"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/controls/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] || 'CommonCreateComplianceControlResponse'

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

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

#create_compliance_framework(body, opts = {}) ⇒ CommonCreateComplianceFrameworkResponse

Create a new custom compliance framework

Parameters:

Returns:



170
171
172
173
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 170

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

#create_compliance_framework_with_http_info(body, opts = {}) ⇒ Array<(CommonCreateComplianceFrameworkResponse, Integer, Hash)>

Create a new custom compliance framework

Parameters:

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 179

def create_compliance_framework_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.create_compliance_framework ...'
  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 CloudPolicies.create_compliance_framework"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/frameworks/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] || 'CommonCreateComplianceFrameworkResponse'

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

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

#create_rule_mixin0(body, opts = {}) ⇒ CommonCreateRuleResponse

Create a new rule

Parameters:

  • body (CommonCreateRuleRequest) —

    Rule severity integer to provide maps to the following: 0&#x3D;Critical, 1&#x3D;High, 2&#x3D;Medium and 3&#x3D;Low. For CSPM IOM Custom Rules, logic is mandatory and parent_rule_id should not be specified. For Runtime IOM Custom Rules (KAC), logic is mandatory. Fields &#x60;controls&#x60;, &#x60;resource_type&#x60;, and &#x60;parent_rule_id&#x60; should not be specified. For Managed Rule duplication, parent_rule_id is mandatory and logic should be not specified.

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 236

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

#create_rule_mixin0_with_http_info(body, opts = {}) ⇒ Array<(CommonCreateRuleResponse, Integer, Hash)>

Create a new rule

Parameters:

  • body (CommonCreateRuleRequest) —

    Rule severity integer to provide maps to the following: 0&#x3D;Critical, 1&#x3D;High, 2&#x3D;Medium and 3&#x3D;Low. For CSPM IOM Custom Rules, logic is mandatory and parent_rule_id should not be specified. For Runtime IOM Custom Rules (KAC), logic is mandatory. Fields &#x60;controls&#x60;, &#x60;resource_type&#x60;, and &#x60;parent_rule_id&#x60; should not be specified. For Managed Rule duplication, parent_rule_id is mandatory and logic should be not specified.

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

    the optional parameters

Returns:

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

    CommonCreateRuleResponse data, response status code and response headers



245
246
247
248
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
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 245

def create_rule_mixin0_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.create_rule_mixin0 ...'
  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 CloudPolicies.create_rule_mixin0"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rules/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] || 'CommonCreateRuleResponse'

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

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

#create_rule_override(body, opts = {}) ⇒ CommonCreateRuleOverrideResponse

Create a new rule override

Parameters:

Returns:



302
303
304
305
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 302

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

#create_rule_override_with_http_info(body, opts = {}) ⇒ Array<(CommonCreateRuleOverrideResponse, Integer, Hash)>

Create a new rule override

Parameters:

Returns:



311
312
313
314
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
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 311

def create_rule_override_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.create_rule_override ...'
  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 CloudPolicies.create_rule_override"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rule-overrides/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] || 'CommonCreateRuleOverrideResponse'

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

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

#create_suppression_rule(body, opts = {}) ⇒ SuppressionrulesCreateSuppressionRuleResponse

Create a new suppression rule

Parameters:

Returns:



368
369
370
371
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 368

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

#create_suppression_rule_with_http_info(body, opts = {}) ⇒ Array<(SuppressionrulesCreateSuppressionRuleResponse, Integer, Hash)>

Create a new suppression rule

Parameters:

Returns:



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
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
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 377

def create_suppression_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.create_suppression_rule ...'
  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 CloudPolicies.create_suppression_rule"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/suppression-rules/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] || 'SuppressionrulesCreateSuppressionRuleResponse'

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

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

#delete_compliance_control(ids, opts = {}) ⇒ CommonDeleteComplianceControlResponse

Delete custom compliance controls

Parameters:

  • ids (Array<String>) —

    The uuids of compliance control to delete

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

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 434

def delete_compliance_control(ids, opts = {})
  data, _status_code, _headers = delete_compliance_control_with_http_info(ids, opts)
  data
end

#delete_compliance_control_with_http_info(ids, opts = {}) ⇒ Array<(CommonDeleteComplianceControlResponse, Integer, Hash)>

Delete custom compliance controls

Parameters:

  • ids (Array<String>) —

    The uuids of compliance control to delete

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

    the optional parameters

Returns:



443
444
445
446
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
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 443

def delete_compliance_control_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.delete_compliance_control ...'
  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 CloudPolicies.delete_compliance_control"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/controls/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] || 'CommonDeleteComplianceControlResponse'

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

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

#delete_compliance_framework(ids, opts = {}) ⇒ CommonDeleteComplianceFrameworkResponse

Delete a custom compliance framework and all associated controls and rule assignments

Parameters:

  • ids (String) —

    The uuids of compliance framework to delete

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

    the optional parameters

Returns:



496
497
498
499
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 496

def delete_compliance_framework(ids, opts = {})
  data, _status_code, _headers = delete_compliance_framework_with_http_info(ids, opts)
  data
end

#delete_compliance_framework_with_http_info(ids, opts = {}) ⇒ Array<(CommonDeleteComplianceFrameworkResponse, Integer, Hash)>

Delete a custom compliance framework and all associated controls and rule assignments

Parameters:

  • ids (String) —

    The uuids of compliance framework to delete

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

    the optional parameters

Returns:



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 505

def delete_compliance_framework_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.delete_compliance_framework ...'
  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 CloudPolicies.delete_compliance_framework"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/frameworks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

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

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

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

#delete_rule_mixin0(ids, opts = {}) ⇒ CommonDeleteRuleResponse

Delete a rule

Parameters:

  • ids (Array<String>) —

    The uuids of rules to delete

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

    the optional parameters

Returns:



558
559
560
561
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 558

def delete_rule_mixin0(ids, opts = {})
  data, _status_code, _headers = delete_rule_mixin0_with_http_info(ids, opts)
  data
end

#delete_rule_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(CommonDeleteRuleResponse, Integer, Hash)>

Delete a rule

Parameters:

  • ids (Array<String>) —

    The uuids of rules to delete

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

    the optional parameters

Returns:

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

    CommonDeleteRuleResponse data, response status code and response headers



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 567

def delete_rule_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.delete_rule_mixin0 ...'
  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 CloudPolicies.delete_rule_mixin0"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rules/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] || 'CommonDeleteRuleResponse'

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

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

#delete_rule_override(ids, opts = {}) ⇒ CommonDeleteRuleOverrideResponse

Delete a rule override

Parameters:

  • ids (Array<String>) —

    The uuids of rule overrides to delete

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

    the optional parameters

Returns:



620
621
622
623
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 620

def delete_rule_override(ids, opts = {})
  data, _status_code, _headers = delete_rule_override_with_http_info(ids, opts)
  data
end

#delete_rule_override_with_http_info(ids, opts = {}) ⇒ Array<(CommonDeleteRuleOverrideResponse, Integer, Hash)>

Delete a rule override

Parameters:

  • ids (Array<String>) —

    The uuids of rule overrides to delete

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

    the optional parameters

Returns:



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 629

def delete_rule_override_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.delete_rule_override ...'
  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 CloudPolicies.delete_rule_override"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rule-overrides/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] || 'CommonDeleteRuleOverrideResponse'

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

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

#delete_suppression_rules(ids, opts = {}) ⇒ SuppressionrulesDeleteSuppressionRulesResponse

Delete Suppression Rules by ID

Parameters:

  • ids (Array<String>) —

    The uuids of the suppression rules to delete. A maximum of 10 IDs can be provided.

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

    the optional parameters

Returns:



682
683
684
685
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 682

def delete_suppression_rules(ids, opts = {})
  data, _status_code, _headers = delete_suppression_rules_with_http_info(ids, opts)
  data
end

#delete_suppression_rules_with_http_info(ids, opts = {}) ⇒ Array<(SuppressionrulesDeleteSuppressionRulesResponse, Integer, Hash)>

Delete Suppression Rules by ID

Parameters:

  • ids (Array<String>) —

    The uuids of the suppression rules to delete. A maximum of 10 IDs can be provided.

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

    the optional parameters

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 691

def delete_suppression_rules_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.delete_suppression_rules ...'
  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 CloudPolicies.delete_suppression_rules"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/suppression-rules/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] || 'SuppressionrulesDeleteSuppressionRulesResponse'

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

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

#get_compliance_controls(ids, opts = {}) ⇒ CommonGetComplianceControlsResponse

Get compliance controls by ID

Parameters:

  • ids (Array<String>) —

    The uuids of compliance controls to retrieve

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

    the optional parameters

Returns:



744
745
746
747
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 744

def get_compliance_controls(ids, opts = {})
  data, _status_code, _headers = get_compliance_controls_with_http_info(ids, opts)
  data
end

#get_compliance_controls_with_http_info(ids, opts = {}) ⇒ Array<(CommonGetComplianceControlsResponse, Integer, Hash)>

Get compliance controls by ID

Parameters:

  • ids (Array<String>) —

    The uuids of compliance controls to retrieve

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

    the optional parameters

Returns:



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

def get_compliance_controls_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_compliance_controls ...'
  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 CloudPolicies.get_compliance_controls"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/controls/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] || 'CommonGetComplianceControlsResponse'

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

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

#get_compliance_frameworks(ids, opts = {}) ⇒ CommonGetComplianceFrameworksResponse

Get compliance frameworks by ID

Parameters:

  • ids (Array<String>) —

    The uuids of compliance frameworks to retrieve

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

    the optional parameters

Returns:



806
807
808
809
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 806

def get_compliance_frameworks(ids, opts = {})
  data, _status_code, _headers = get_compliance_frameworks_with_http_info(ids, opts)
  data
end

#get_compliance_frameworks_with_http_info(ids, opts = {}) ⇒ Array<(CommonGetComplianceFrameworksResponse, Integer, Hash)>

Get compliance frameworks by ID

Parameters:

  • ids (Array<String>) —

    The uuids of compliance frameworks to retrieve

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

    the optional parameters

Returns:



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

def get_compliance_frameworks_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_compliance_frameworks ...'
  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 CloudPolicies.get_compliance_frameworks"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/frameworks/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] || 'CommonGetComplianceFrameworksResponse'

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

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

#get_enriched_asset(opts = {}) ⇒ CommonCursorQueryResponse

Gets enriched assets that combine a primary resource with all its related resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    List of asset IDs (maximum 100 IDs allowed).

  • :domain (String) —

    Rule domain (Currently only used for KAC Rego rules)

  • :subdomain (String) —

    Rule subdomain (Currently only used for KAC Rego rules)

  • :resource_type (String) —

    Currently the Resource type field is only used when KAC Rules are specified vai Domain: Runtime &amp; Subdomain: IOM. For KAC rules, we return static sample data instead of real assets b/c we don&#39;t have KAC payloads stored for customers. This field valued selects what sample data resource type we return which the UI shows in the Rego Editor to do test evaluations

Returns:



871
872
873
874
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 871

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

#get_enriched_asset_with_http_info(opts = {}) ⇒ Array<(CommonCursorQueryResponse, Integer, Hash)>

Gets enriched assets that combine a primary resource with all its related resources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    List of asset IDs (maximum 100 IDs allowed).

  • :domain (String) —

    Rule domain (Currently only used for KAC Rego rules)

  • :subdomain (String) —

    Rule subdomain (Currently only used for KAC Rego rules)

  • :resource_type (String) —

    Currently the Resource type field is only used when KAC Rules are specified vai Domain: Runtime &amp; Subdomain: IOM. For KAC rules, we return static sample data instead of real assets b/c we don&#39;t have KAC payloads stored for customers. This field valued selects what sample data resource type we return which the UI shows in the Rego Editor to do test evaluations

Returns:

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

    CommonCursorQueryResponse data, response status code and response headers



883
884
885
886
887
888
889
890
891
892
893
894
895
896
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
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 883

def get_enriched_asset_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_enriched_asset ...'
  end
  allowable_values = ["cronjobs", "daemonsets", "deployments", "jobs", "pods", "replicasets", "replicationcontrollers", "services", "statefulsets"]
  if @api_client.config.client_side_validation && opts[:'resource_type'] && !allowable_values.include?(opts[:'resource_type'])
    fail ArgumentError, "invalid value for \"resource_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/enriched-resources/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?
  query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
  query_params[:'subdomain'] = opts[:'subdomain'] if !opts[:'subdomain'].nil?
  query_params[:'resource_type'] = opts[:'resource_type'] if !opts[:'resource_type'].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] || 'CommonCursorQueryResponse'

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

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

#get_evaluation_result(body, opts = {}) ⇒ CommonCursorQueryResponse

Gets evaluation results based on the provided rule

Parameters:

Options Hash (opts):

  • :cloud_provider (String) —

    Cloud Service Provider of the provided IDs

  • :resource_type (String) —

    Resource Type of the provided IDs

  • :ids (Array<String>) —

    List of assets to evaluate (maximum 100 IDs allowed).

Returns:



942
943
944
945
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 942

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

#get_evaluation_result_with_http_info(body, opts = {}) ⇒ Array<(CommonCursorQueryResponse, Integer, Hash)>

Gets evaluation results based on the provided rule

Parameters:

Options Hash (opts):

  • :cloud_provider (String) —

    Cloud Service Provider of the provided IDs

  • :resource_type (String) —

    Resource Type of the provided IDs

  • :ids (Array<String>) —

    List of assets to evaluate (maximum 100 IDs allowed).

Returns:

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

    CommonCursorQueryResponse data, response status code and response headers



954
955
956
957
958
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
1007
1008
1009
1010
1011
1012
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 954

def get_evaluation_result_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_evaluation_result ...'
  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 CloudPolicies.get_evaluation_result"
  end
  allowable_values = ["aws", "azure", "gcp", "oci"]
  if @api_client.config.client_side_validation && opts[:'cloud_provider'] && !allowable_values.include?(opts[:'cloud_provider'])
    fail ArgumentError, "invalid value for \"cloud_provider\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/evaluation/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cloud_provider'] = opts[:'cloud_provider'] if !opts[:'cloud_provider'].nil?
  query_params[:'resource_type'] = opts[:'resource_type'] if !opts[:'resource_type'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].nil?

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

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

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

#get_rule(ids, opts = {}) ⇒ CommonGetRulesResponse

Get a rule by id

Parameters:

  • ids (Array<String>) —

    The uuids of rules to retrieve

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

    the optional parameters

Returns:



1018
1019
1020
1021
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1018

def get_rule(ids, opts = {})
  data, _status_code, _headers = get_rule_with_http_info(ids, opts)
  data
end

#get_rule_input_schema(domain, subdomain, resource_type, opts = {}) ⇒ CommonRuleInputSchemaResponse

Get rule input schema for given resource type

Parameters:

  • domain (String) —

    domain

  • subdomain (String) —

    subdomain

  • resource_type (String) —

    Selects the resource type for which to retrieve the rule input schema

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

    the optional parameters

Options Hash (opts):

  • :cloud_provider (String) —

    Cloud service provider for the resource type

Returns:



1083
1084
1085
1086
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1083

def get_rule_input_schema(domain, subdomain, resource_type, opts = {})
  data, _status_code, _headers = get_rule_input_schema_with_http_info(domain, subdomain, resource_type, opts)
  data
end

#get_rule_input_schema_with_http_info(domain, subdomain, resource_type, opts = {}) ⇒ Array<(CommonRuleInputSchemaResponse, Integer, Hash)>

Get rule input schema for given resource type

Parameters:

  • domain (String) —

    domain

  • subdomain (String) —

    subdomain

  • resource_type (String) —

    Selects the resource type for which to retrieve the rule input schema

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

    the optional parameters

Options Hash (opts):

  • :cloud_provider (String) —

    Cloud service provider for the resource type

Returns:



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
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1095

def get_rule_input_schema_with_http_info(domain, subdomain, resource_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_rule_input_schema ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling CloudPolicies.get_rule_input_schema"
  end
  # verify the required parameter 'subdomain' is set
  if @api_client.config.client_side_validation && subdomain.nil?
    fail ArgumentError, "Missing the required parameter 'subdomain' when calling CloudPolicies.get_rule_input_schema"
  end
  # verify the required parameter 'resource_type' is set
  if @api_client.config.client_side_validation && resource_type.nil?
    fail ArgumentError, "Missing the required parameter 'resource_type' when calling CloudPolicies.get_rule_input_schema"
  end
  allowable_values = ["aws", "azure", "gcp", "oci"]
  if @api_client.config.client_side_validation && opts[:'cloud_provider'] && !allowable_values.include?(opts[:'cloud_provider'])
    fail ArgumentError, "invalid value for \"cloud_provider\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/cloud-policies/combined/rules/input-schema/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'domain'] = domain
  query_params[:'subdomain'] = subdomain
  query_params[:'resource_type'] = resource_type
  query_params[:'cloud_provider'] = opts[:'cloud_provider'] if !opts[:'cloud_provider'].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] || 'CommonRuleInputSchemaResponse'

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

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

#get_rule_override(ids, opts = {}) ⇒ CommonGetRuleOverrideResponse

Get a rule override

Parameters:

  • ids (Array<String>) —

    The uuids of rule overrides to retrieve

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

    the optional parameters

Returns:



1163
1164
1165
1166
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1163

def get_rule_override(ids, opts = {})
  data, _status_code, _headers = get_rule_override_with_http_info(ids, opts)
  data
end

#get_rule_override_with_http_info(ids, opts = {}) ⇒ Array<(CommonGetRuleOverrideResponse, Integer, Hash)>

Get a rule override

Parameters:

  • ids (Array<String>) —

    The uuids of rule overrides to retrieve

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

    the optional parameters

Returns:



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1172

def get_rule_override_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_rule_override ...'
  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 CloudPolicies.get_rule_override"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rule-overrides/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] || 'CommonGetRuleOverrideResponse'

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

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

#get_rule_with_http_info(ids, opts = {}) ⇒ Array<(CommonGetRulesResponse, Integer, Hash)>

Get a rule by id

Parameters:

  • ids (Array<String>) —

    The uuids of rules to retrieve

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

    the optional parameters

Returns:

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

    CommonGetRulesResponse data, response status code and response headers



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
1069
1070
1071
1072
1073
1074
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1027

def get_rule_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_rule ...'
  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 CloudPolicies.get_rule"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rules/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] || 'CommonGetRulesResponse'

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

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

#get_suppression_rules(ids, opts = {}) ⇒ SuppressionrulesGetSuppressionRulesResponse

Get Suppression Rules by ID

Parameters:

  • ids (Array<String>) —

    The uuids of the suppression rules to retrieve

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

    the optional parameters

Returns:



1225
1226
1227
1228
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1225

def get_suppression_rules(ids, opts = {})
  data, _status_code, _headers = get_suppression_rules_with_http_info(ids, opts)
  data
end

#get_suppression_rules_with_http_info(ids, opts = {}) ⇒ Array<(SuppressionrulesGetSuppressionRulesResponse, Integer, Hash)>

Get Suppression Rules by ID

Parameters:

  • ids (Array<String>) —

    The uuids of the suppression rules to retrieve

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

    the optional parameters

Returns:



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1234

def get_suppression_rules_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.get_suppression_rules ...'
  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 CloudPolicies.get_suppression_rules"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/suppression-rules/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] || 'SuppressionrulesGetSuppressionRulesResponse'

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

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

#query_compliance_controls(opts = {}) ⇒ CommonQueryResponse

Query for compliance controls by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed props: compliance_control_name compliance_control_authority compliance_control_type compliance_control_section compliance_control_requirement compliance_control_benchmark_name compliance_control_benchmark_version

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: compliance_control_name compliance_control_authority compliance_control_type compliance_control_section compliance_control_requirement compliance_control_benchmark_name compliance_control_benchmark_version Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:



1290
1291
1292
1293
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1290

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

#query_compliance_controls_with_http_info(opts = {}) ⇒ Array<(CommonQueryResponse, Integer, Hash)>

Query for compliance controls by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed props: compliance_control_name compliance_control_authority compliance_control_type compliance_control_section compliance_control_requirement compliance_control_benchmark_name compliance_control_benchmark_version

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: compliance_control_name compliance_control_authority compliance_control_type compliance_control_section compliance_control_requirement compliance_control_benchmark_name compliance_control_benchmark_version Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:

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

    CommonQueryResponse data, response status code and response headers



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1302

def query_compliance_controls_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.query_compliance_controls ...'
  end
  # resource path
  local_var_path = '/cloud-policies/queries/compliance/controls/v1'

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

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

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

#query_compliance_frameworks(opts = {}) ⇒ CommonQueryResponse

Query for compliance frameworks by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: compliance_framework_name compliance_framework_version compliance_framework_authority

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: compliance_framework_name compliance_framework_version compliance_framework_authority Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:



1357
1358
1359
1360
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1357

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

#query_compliance_frameworks_with_http_info(opts = {}) ⇒ Array<(CommonQueryResponse, Integer, Hash)>

Query for compliance frameworks by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: compliance_framework_name compliance_framework_version compliance_framework_authority

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: compliance_framework_name compliance_framework_version compliance_framework_authority Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:

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

    CommonQueryResponse data, response status code and response headers



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1369

def query_compliance_frameworks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.query_compliance_frameworks ...'
  end
  # resource path
  local_var_path = '/cloud-policies/queries/compliance/frameworks/v1'

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

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

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

#query_rule(opts = {}) ⇒ CommonQueryResponse

Query for rules by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: rule_auto_remediable rule_category rule_cloneable rule_compliance_benchmark rule_compliance_benchmark_uuid rule_compliance_framework rule_control_requirement rule_control_section rule_created_at rule_description rule_domain rule_mitre_tactic rule_mitre_technique rule_name rule_origin rule_parent_uuid rule_provider rule_resource_type rule_resource_type_name rule_risk_factor rule_service rule_severity rule_short_code rule_status rule_subdomain rule_updated_at rule_updated_by

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: rule_auto_remediable rule_category rule_cloneable rule_compliance_benchmark rule_compliance_benchmark_uuid rule_compliance_framework rule_control_requirement rule_control_section rule_created_at rule_description rule_domain rule_mitre_tactic rule_mitre_technique rule_name rule_origin rule_parent_uuid rule_provider rule_resource_type rule_resource_type_name rule_risk_factor rule_service rule_severity rule_short_code rule_status rule_subdomain rule_updated_at rule_updated_by Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:



1424
1425
1426
1427
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1424

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

#query_rule_with_http_info(opts = {}) ⇒ Array<(CommonQueryResponse, Integer, Hash)>

Query for rules by various parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: rule_auto_remediable rule_category rule_cloneable rule_compliance_benchmark rule_compliance_benchmark_uuid rule_compliance_framework rule_control_requirement rule_control_section rule_created_at rule_description rule_domain rule_mitre_tactic rule_mitre_technique rule_name rule_origin rule_parent_uuid rule_provider rule_resource_type rule_resource_type_name rule_risk_factor rule_service rule_severity rule_short_code rule_status rule_subdomain rule_updated_at rule_updated_by

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: rule_auto_remediable rule_category rule_cloneable rule_compliance_benchmark rule_compliance_benchmark_uuid rule_compliance_framework rule_control_requirement rule_control_section rule_created_at rule_description rule_domain rule_mitre_tactic rule_mitre_technique rule_name rule_origin rule_parent_uuid rule_provider rule_resource_type rule_resource_type_name rule_risk_factor rule_service rule_severity rule_short_code rule_status rule_subdomain rule_updated_at rule_updated_by Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:

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

    CommonQueryResponse data, response status code and response headers



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1436

def query_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.query_rule ...'
  end
  # resource path
  local_var_path = '/cloud-policies/queries/rules/v1'

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

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

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

#query_suppression_rules(opts = {}) ⇒ SuppressionrulesQuerySuppressionRulesResponse

Query suppression rules with filtering, sorting and pagination

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL expression to filter suppression rules. The allowed properties are: name description domain subdomain suppression_expiration_date suppression_reason created_by created_at last_modified_at disabled groups

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 50. (default to 20)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: name description domain subdomain suppression_expiration_date suppression_reason created_by created_at last_modified_at disabled groups Use the &#x60;.asc&#x60; or &#x60;.desc&#x60; suffix to specify sort direction.

Returns:



1491
1492
1493
1494
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1491

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

#query_suppression_rules_with_http_info(opts = {}) ⇒ Array<(SuppressionrulesQuerySuppressionRulesResponse, Integer, Hash)>

Query suppression rules with filtering, sorting and pagination

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL expression to filter suppression rules. The allowed properties are: name description domain subdomain suppression_expiration_date suppression_reason created_by created_at last_modified_at disabled groups

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 50. (default to 20)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: name description domain subdomain suppression_expiration_date suppression_reason created_by created_at last_modified_at disabled groups Use the &#x60;.asc&#x60; or &#x60;.desc&#x60; suffix to specify sort direction.

Returns:



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1503

def query_suppression_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.query_suppression_rules ...'
  end
  # resource path
  local_var_path = '/cloud-policies/queries/suppression-rules/v1'

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

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

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

#rename_section_compliance_framework(ids, section_name, body, opts = {}) ⇒ CommonRenameSectionResponse

Rename a section in a custom compliance framework

Parameters:

  • ids (String) —

    The uuid of compliance framework containing the section to rename

  • section_name (String) —

    The current name of the section to rename

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

    the optional parameters

Returns:



1557
1558
1559
1560
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1557

def rename_section_compliance_framework(ids, section_name, body, opts = {})
  data, _status_code, _headers = rename_section_compliance_framework_with_http_info(ids, section_name, body, opts)
  data
end

#rename_section_compliance_framework_with_http_info(ids, section_name, body, opts = {}) ⇒ Array<(CommonRenameSectionResponse, Integer, Hash)>

Rename a section in a custom compliance framework

Parameters:

  • ids (String) —

    The uuid of compliance framework containing the section to rename

  • section_name (String) —

    The current name of the section to rename

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

    the optional parameters

Returns:

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

    CommonRenameSectionResponse data, response status code and response headers



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1568

def rename_section_compliance_framework_with_http_info(ids, section_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.rename_section_compliance_framework ...'
  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 CloudPolicies.rename_section_compliance_framework"
  end
  # verify the required parameter 'section_name' is set
  if @api_client.config.client_side_validation && section_name.nil?
    fail ArgumentError, "Missing the required parameter 'section_name' when calling CloudPolicies.rename_section_compliance_framework"
  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 CloudPolicies.rename_section_compliance_framework"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/frameworks/section/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids
  query_params[:'sectionName'] = section_name

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

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

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

#replace_control_rules(ids, body, opts = {}) ⇒ CommonAssignRulesToControlResponse

Assign rules to a compliance control (full replace)

Parameters:

  • ids (String) —

    The UUID of the compliance control to assign rules to

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

    the optional parameters

Returns:



1636
1637
1638
1639
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1636

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

#replace_control_rules_with_http_info(ids, body, opts = {}) ⇒ Array<(CommonAssignRulesToControlResponse, Integer, Hash)>

Assign rules to a compliance control (full replace)

Parameters:

  • ids (String) —

    The UUID of the compliance control to assign rules to

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

    the optional parameters

Returns:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1646

def replace_control_rules_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.replace_control_rules ...'
  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 CloudPolicies.replace_control_rules"
  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 CloudPolicies.replace_control_rules"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/control-rule-assignments/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

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

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

  new_options = opts.merge(
    :operation => :"CloudPolicies.replace_control_rules",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudPolicies#replace_control_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_compliance_control(ids, body, opts = {}) ⇒ CommonCreateComplianceControlResponse

Update a custom compliance control

Parameters:

Returns:



1709
1710
1711
1712
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1709

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

#update_compliance_control_with_http_info(ids, body, opts = {}) ⇒ Array<(CommonCreateComplianceControlResponse, Integer, Hash)>

Update a custom compliance control

Parameters:

Returns:



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1719

def update_compliance_control_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.update_compliance_control ...'
  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 CloudPolicies.update_compliance_control"
  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 CloudPolicies.update_compliance_control"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/controls/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

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

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

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

#update_compliance_framework(ids, body, opts = {}) ⇒ CommonCreateComplianceFrameworkResponse

Update a custom compliance framework

Parameters:

Returns:



1782
1783
1784
1785
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1782

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

#update_compliance_framework_with_http_info(ids, body, opts = {}) ⇒ Array<(CommonCreateComplianceFrameworkResponse, Integer, Hash)>

Update a custom compliance framework

Parameters:

Returns:



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1792

def update_compliance_framework_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.update_compliance_framework ...'
  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 CloudPolicies.update_compliance_framework"
  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 CloudPolicies.update_compliance_framework"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/compliance/frameworks/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

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

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

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

#update_rule(body, opts = {}) ⇒ CommonGetRulesResponse

Update a rule

Parameters:

Returns:



1854
1855
1856
1857
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1854

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

#update_rule_override(body, opts = {}) ⇒ CommonUpdateRuleOverrideResponse

Update a rule override

Parameters:

Returns:



1920
1921
1922
1923
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1920

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

#update_rule_override_with_http_info(body, opts = {}) ⇒ Array<(CommonUpdateRuleOverrideResponse, Integer, Hash)>

Update a rule override

Parameters:

Returns:



1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1929

def update_rule_override_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.update_rule_override ...'
  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 CloudPolicies.update_rule_override"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rule-overrides/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] || 'CommonUpdateRuleOverrideResponse'

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

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

#update_rule_with_http_info(body, opts = {}) ⇒ Array<(CommonGetRulesResponse, Integer, Hash)>

Update a rule

Parameters:

Returns:

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

    CommonGetRulesResponse data, response status code and response headers



1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1863

def update_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.update_rule ...'
  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 CloudPolicies.update_rule"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/rules/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] || 'CommonGetRulesResponse'

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

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

#update_suppression_rule(body, opts = {}) ⇒ SuppressionrulesUpdateSuppressionRuleResponse

Update a suppression rule

Parameters:

Returns:



1986
1987
1988
1989
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1986

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

#update_suppression_rule_with_http_info(body, opts = {}) ⇒ Array<(SuppressionrulesUpdateSuppressionRuleResponse, Integer, Hash)>

Update a suppression rule

Parameters:

Returns:



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/crimson-falcon/api/cloud_policies.rb', line 1995

def update_suppression_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudPolicies.update_suppression_rule ...'
  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 CloudPolicies.update_suppression_rule"
  end
  # resource path
  local_var_path = '/cloud-policies/entities/suppression-rules/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] || 'SuppressionrulesUpdateSuppressionRuleResponse'

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

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