Class: Falcon::CustomIoaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomIoaApi

Returns a new instance of CustomIoaApi.



36
37
38
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#create_rule(body, opts = {}) ⇒ ApiRulesResponse

Create a rule within a rule group. Returns the rule.

Parameters:

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

    the optional parameters

Returns:



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

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

#create_rule_group_mixin0(body, opts = {}) ⇒ ApiRuleGroupsResponse

Create a rule group for a platform with a name and an optional description. Returns the rule group.

Parameters:

Returns:



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

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

#create_rule_group_mixin0_with_http_info(body, opts = {}) ⇒ Array<(ApiRuleGroupsResponse, Integer, Hash)>

Create a rule group for a platform with a name and an optional description. Returns the rule group.

Parameters:

Returns:

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

    ApiRuleGroupsResponse data, response status code and response headers



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

def create_rule_group_mixin0_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.create_rule_group_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 CustomIoaApi.create_rule_group_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/entities/rule-groups/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

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

#create_rule_with_http_info(body, opts = {}) ⇒ Array<(ApiRulesResponse, Integer, Hash)>

Create a rule within a rule group. Returns the rule.

Parameters:

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

    the optional parameters

Returns:

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

    ApiRulesResponse data, response status code and response headers



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 52

def create_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.create_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 CustomIoaApi.create_rule"
  end
  # resource path
  local_var_path = '/ioarules/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] || 'ApiRulesResponse'

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

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

#delete_rule_groups_mixin0(ids, opts = {}) ⇒ MsaReplyMetaOnly

Delete rule groups by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why the entity is being deleted

Returns:



176
177
178
179
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 176

def delete_rule_groups_mixin0(ids, opts = {})
  data, _status_code, _headers = delete_rule_groups_mixin0_with_http_info(ids, opts)
  data
end

#delete_rule_groups_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete rule groups by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why the entity is being deleted

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers



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

def delete_rule_groups_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.delete_rule_groups_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 CustomIoaApi.delete_rule_groups_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/entities/rule-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].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] || 'MsaReplyMetaOnly'

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

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

#delete_rules(rule_group_id, ids, opts = {}) ⇒ MsaReplyMetaOnly

Delete rules from a rule group by ID.

Parameters:

  • rule_group_id (String) —

    The parent rule group

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why the entity is being deleted

Returns:



242
243
244
245
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 242

def delete_rules(rule_group_id, ids, opts = {})
  data, _status_code, _headers = delete_rules_with_http_info(rule_group_id, ids, opts)
  data
end

#delete_rules_with_http_info(rule_group_id, ids, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete rules from a rule group by ID.

Parameters:

  • rule_group_id (String) —

    The parent rule group

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Options Hash (opts):

  • :comment (String) —

    Explains why the entity is being deleted

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers



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

def delete_rules_with_http_info(rule_group_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.delete_rules ...'
  end
  # verify the required parameter 'rule_group_id' is set
  if @api_client.config.client_side_validation && rule_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_group_id' when calling CustomIoaApi.delete_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 CustomIoaApi.delete_rules"
  end
  # resource path
  local_var_path = '/ioarules/entities/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rule_group_id'] = rule_group_id
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].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] || 'MsaReplyMetaOnly'

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

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

#get_patterns(ids, opts = {}) ⇒ ApiPatternsResponse

Get pattern severities by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:



312
313
314
315
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 312

def get_patterns(ids, opts = {})
  data, _status_code, _headers = get_patterns_with_http_info(ids, opts)
  data
end

#get_patterns_with_http_info(ids, opts = {}) ⇒ Array<(ApiPatternsResponse, Integer, Hash)>

Get pattern severities by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:

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

    ApiPatternsResponse data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 321

def get_patterns_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_patterns ...'
  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 CustomIoaApi.get_patterns"
  end
  # resource path
  local_var_path = '/ioarules/entities/pattern-severities/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] || 'ApiPatternsResponse'

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

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

#get_platforms_mixin0(ids, opts = {}) ⇒ ApiPlatformsResponse

Get platforms by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:



374
375
376
377
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 374

def get_platforms_mixin0(ids, opts = {})
  data, _status_code, _headers = get_platforms_mixin0_with_http_info(ids, opts)
  data
end

#get_platforms_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(ApiPlatformsResponse, Integer, Hash)>

Get platforms by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:

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

    ApiPlatformsResponse data, response status code and response headers



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 383

def get_platforms_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_platforms_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 CustomIoaApi.get_platforms_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/entities/platforms/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] || 'ApiPlatformsResponse'

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

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

#get_rule_groups_mixin0(ids, opts = {}) ⇒ ApiRuleGroupsResponse

Get rule groups by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:



436
437
438
439
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 436

def get_rule_groups_mixin0(ids, opts = {})
  data, _status_code, _headers = get_rule_groups_mixin0_with_http_info(ids, opts)
  data
end

#get_rule_groups_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(ApiRuleGroupsResponse, Integer, Hash)>

Get rule groups by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:

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

    ApiRuleGroupsResponse data, response status code and response headers



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
491
492
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 445

def get_rule_groups_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_rule_groups_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 CustomIoaApi.get_rule_groups_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/entities/rule-groups/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] || 'ApiRuleGroupsResponse'

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

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

#get_rule_types(ids, opts = {}) ⇒ ApiRuleTypesResponse

Get rule types by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:



498
499
500
501
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 498

def get_rule_types(ids, opts = {})
  data, _status_code, _headers = get_rule_types_with_http_info(ids, opts)
  data
end

#get_rule_types_with_http_info(ids, opts = {}) ⇒ Array<(ApiRuleTypesResponse, Integer, Hash)>

Get rule types by ID.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:

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

    ApiRuleTypesResponse data, response status code and response headers



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
553
554
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 507

def get_rule_types_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_rule_types ...'
  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 CustomIoaApi.get_rule_types"
  end
  # resource path
  local_var_path = '/ioarules/entities/rule-types/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] || 'ApiRuleTypesResponse'

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

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

#get_rules_get(body, opts = {}) ⇒ ApiRulesResponse

Get rules by ID and optionally with cid and/or version in the following format: ‘[cid:]ID`.

Parameters:

  • body (ApiRulesGetRequestV1) —

    The &quot;ids&quot; field contains a list of the rules to retrieve.

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

    the optional parameters

Returns:



560
561
562
563
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 560

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

#get_rules_get_with_http_info(body, opts = {}) ⇒ Array<(ApiRulesResponse, Integer, Hash)>

Get rules by ID and optionally with cid and/or version in the following format: &#x60;[cid:]ID&#x60;.

Parameters:

  • body (ApiRulesGetRequestV1) —

    The &quot;ids&quot; field contains a list of the rules to retrieve.

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

    the optional parameters

Returns:

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

    ApiRulesResponse data, response status code and response headers



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

def get_rules_get_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_rules_get ...'
  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 CustomIoaApi.get_rules_get"
  end
  # resource path
  local_var_path = '/ioarules/entities/rules/GET/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] || 'ApiRulesResponse'

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

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

#get_rules_mixin0(ids, opts = {}) ⇒ ApiRulesResponse

Get rules by ID and optionally with cid and/or version in the following format: ‘[cid:]ID`. The max number of IDs is constrained by URL size.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:



626
627
628
629
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 626

def get_rules_mixin0(ids, opts = {})
  data, _status_code, _headers = get_rules_mixin0_with_http_info(ids, opts)
  data
end

#get_rules_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(ApiRulesResponse, Integer, Hash)>

Get rules by ID and optionally with cid and/or version in the following format: &#x60;[cid:]ID&#x60;. The max number of IDs is constrained by URL size.

Parameters:

  • ids (Array<String>) —

    The IDs of the entities

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

    the optional parameters

Returns:

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

    ApiRulesResponse data, response status code and response headers



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
677
678
679
680
681
682
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 635

def get_rules_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.get_rules_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 CustomIoaApi.get_rules_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/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] || 'ApiRulesResponse'

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

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

#query_patterns(opts = {}) ⇒ MsaQueryResponse

Get all pattern severity IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



689
690
691
692
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 689

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

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

Get all pattern severity IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
739
740
741
742
743
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 699

def query_patterns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_patterns ...'
  end
  # resource path
  local_var_path = '/ioarules/queries/pattern-severities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#query_platforms_mixin0(opts = {}) ⇒ MsaQueryResponse

Get all platform IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



750
751
752
753
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 750

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

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

Get all platform IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
801
802
803
804
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 760

def query_platforms_mixin0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_platforms_mixin0 ...'
  end
  # resource path
  local_var_path = '/ioarules/queries/platforms/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#query_rule_groups_full(opts = {}) ⇒ MsaQueryResponse

Find all rule groups matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: name, created_by, created_on, modified_by, modified_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



814
815
816
817
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 814

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

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

Find all rule groups matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: name, created_by, created_on, modified_by, modified_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 827

def query_rule_groups_full_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_rule_groups_full ...'
  end
  allowable_values = ["created_by", "created_on", "enabled", "modified_by", "modified_on", "name"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ioarules/queries/rule-groups-full/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#query_rule_groups_mixin0(opts = {}) ⇒ MsaQueryResponse

Finds all rule group IDs matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: name, created_by, created_on, modified_by, modified_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



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

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

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

Finds all rule group IDs matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: name, created_by, created_on, modified_by, modified_on

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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

def query_rule_groups_mixin0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_rule_groups_mixin0 ...'
  end
  allowable_values = ["created_by", "created_on", "enabled", "modified_by", "modified_on", "name"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ioarules/queries/rule-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#query_rule_types(opts = {}) ⇒ MsaQueryResponse

Get all rule type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



959
960
961
962
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 959

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

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

Get all rule type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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

def query_rule_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_rule_types ...'
  end
  # resource path
  local_var_path = '/ioarules/queries/rule-types/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#query_rules_mixin0(opts = {}) ⇒ MsaQueryResponse

Finds all rule IDs matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: rules.current_version.action_label, rules.current_version.modified_on, rules.created_on, rules.current_version.name, rules.created_by, rules.current_version.pattern_severity, rules.current_version.modified_by, rules.ruletype_name, rules.enabled

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:



1023
1024
1025
1026
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 1023

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

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

Finds all rule IDs matching the query with optional filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    Possible order by fields: rules.current_version.action_label, rules.current_version.modified_on, rules.created_on, rules.current_version.name, rules.created_by, rules.current_version.pattern_severity, rules.current_version.modified_by, rules.ruletype_name, rules.enabled

  • :filter (String) —

    FQL query specifying the filter parameters. Filter term criteria: [enabled platform name description rules.action_label rules.name rules.description rules.pattern_severity rules.ruletype_name rules.enabled]. Filter range criteria: created_on, modified_on; use any common date format, such as &#39;2010-05-15T14:55:21.892315096Z&#39;.

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :offset (String) —

    Starting index of overall result set from which to return IDs

  • :limit (Integer) —

    Number of IDs to return

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 1036

def query_rules_mixin0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.query_rules_mixin0 ...'
  end
  allowable_values = ["rules.created_by", "rules.created_on", "rules.current_version.action_label", "rules.current_version.description", "rules.current_version.modified_by", "rules.current_version.modified_on", "rules.current_version.name", "rules.current_version.pattern_severity", "rules.enabled", "rules.ruletype_name"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ioarules/queries/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

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

#update_rule_group_mixin0(body, opts = {}) ⇒ ApiRuleGroupsResponse

Update a rule group. The following properties can be modified: name, description, enabled.

Parameters:

Returns:



1093
1094
1095
1096
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 1093

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

#update_rule_group_mixin0_with_http_info(body, opts = {}) ⇒ Array<(ApiRuleGroupsResponse, Integer, Hash)>

Update a rule group. The following properties can be modified: name, description, enabled.

Parameters:

Returns:

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

    ApiRuleGroupsResponse data, response status code and response headers



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

def update_rule_group_mixin0_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.update_rule_group_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 CustomIoaApi.update_rule_group_mixin0"
  end
  # resource path
  local_var_path = '/ioarules/entities/rule-groups/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

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

#update_rules(body, opts = {}) ⇒ ApiRulesResponse

Update rules within a rule group. Return the updated rules.

Parameters:

Returns:



1159
1160
1161
1162
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 1159

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

#update_rules_with_http_info(body, opts = {}) ⇒ Array<(ApiRulesResponse, Integer, Hash)>

Update rules within a rule group. Return the updated rules.

Parameters:

Returns:

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

    ApiRulesResponse data, response status code and response headers



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
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/custom_ioa_api.rb', line 1168

def update_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.update_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 CustomIoaApi.update_rules"
  end
  # resource path
  local_var_path = '/ioarules/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] || 'ApiRulesResponse'

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

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

#validate(body, opts = {}) ⇒ ApiValidationResponseV1

Validates field values and checks for matches if a test string is provided.

Parameters:

Returns:



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

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

#validate_with_http_info(body, opts = {}) ⇒ Array<(ApiValidationResponseV1, Integer, Hash)>

Validates field values and checks for matches if a test string is provided.

Parameters:

Returns:

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

    ApiValidationResponseV1 data, response status code and response headers



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
1282
1283
1284
1285
 
# File 'lib/crimson-falcon/api/custom_ioa_api.rb', line 1234

def validate_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomIoaApi.validate ...'
  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 CustomIoaApi.validate"
  end
  # resource path
  local_var_path = '/ioarules/entities/rules/validate/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] || 'ApiValidationResponseV1'

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

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