Class: Falcon::SaasSecurity

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SaasSecurity

Returns a new instance of SaasSecurity.



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

def api_client
  @api_client
end

Instance Method Details

#dismiss_affected_entity_v3(id, body, opts = {}) ⇒ DismissAffected

POST Dismiss Affected Entity Preform dismiss to an affected entity in a security check

Parameters:

Returns:



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

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

#dismiss_affected_entity_v3_with_http_info(id, body, opts = {}) ⇒ Array<(DismissAffected, Integer, Hash)>

POST Dismiss Affected Entity Preform dismiss to an affected entity in a security check

Parameters:

Returns:

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

    DismissAffected data, response status code and response headers



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
104
105
106
107
108
109
110
111
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 55

def dismiss_affected_entity_v3_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.dismiss_affected_entity_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.dismiss_affected_entity_v3"
  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 SaasSecurity.dismiss_affected_entity_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/check-dismiss-affected/v3'

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

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

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

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

#dismiss_security_check_v3(id, body, opts = {}) ⇒ DismissSecurityCheck

POST Dismiss Security Check by ID Perform dismiss to a security check

Parameters:

Returns:



119
120
121
122
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 119

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

#dismiss_security_check_v3_with_http_info(id, body, opts = {}) ⇒ Array<(DismissSecurityCheck, Integer, Hash)>

POST Dismiss Security Check by ID Perform dismiss to a security check

Parameters:

Returns:

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

    DismissSecurityCheck data, response status code and response headers



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 130

def dismiss_security_check_v3_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.dismiss_security_check_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.dismiss_security_check_v3"
  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 SaasSecurity.dismiss_security_check_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/check-dismiss/v3'

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

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

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

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

#get_activity_monitor_v3(opts = {}) ⇒ GetActivityMonitor

GET Activity Monitor Get a list of all events in monitor

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Integration ID

  • :actor (String) —

    Actor

  • :category (String) —

    Comma separated list of categories

  • :projection (String) —

    Comma separated list of projections

  • :from_date (Time) —

    From Date

  • :to_date (Time) —

    To Date

  • :limit (Integer) —

    Max number of logs to fetch

  • :skip (Integer) —

    Number of logs to skip

Returns:



200
201
202
203
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 200

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

#get_activity_monitor_v3_with_http_info(opts = {}) ⇒ Array<(GetActivityMonitor, Integer, Hash)>

GET Activity Monitor Get a list of all events in monitor

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Integration ID

  • :actor (String) —

    Actor

  • :category (String) —

    Comma separated list of categories

  • :projection (String) —

    Comma separated list of projections

  • :from_date (Time) —

    From Date

  • :to_date (Time) —

    To Date

  • :limit (Integer) —

    Max number of logs to fetch

  • :skip (Integer) —

    Number of logs to skip

Returns:

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

    GetActivityMonitor data, response status code and response headers



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 217

def get_activity_monitor_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_activity_monitor_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/monitor/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'actor'] = opts[:'actor'] if !opts[:'actor'].nil?
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'projection'] = opts[:'projection'] if !opts[:'projection'].nil?
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].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] || 'GetActivityMonitor'

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

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

#get_alerts_v3(opts = {}) ⇒ GetAlertsResponse

GET Alert by ID or GET Alerts Get a data on a specific alert or get a list of all alerts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Alert ID

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :last_id (String) —

    The last id of the alert you want to get

  • :type (String) —

    The type of alert you want to get

  • :integration_id (String) —

    Comma separated list of integration ID&#39;s of the alert you want to get

  • :from_date (Time) —

    The start date of the alert you want to get (in YYYY-MM-DD format)

  • :to_date (Time) —

    The end date of the alert you want to get (in YYYY-MM-DD format)

  • :ascending (Boolean)

Returns:



282
283
284
285
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 282

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

#get_alerts_v3_with_http_info(opts = {}) ⇒ Array<(GetAlertsResponse, Integer, Hash)>

GET Alert by ID or GET Alerts Get a data on a specific alert or get a list of all alerts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Alert ID

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :last_id (String) —

    The last id of the alert you want to get

  • :type (String) —

    The type of alert you want to get

  • :integration_id (String) —

    Comma separated list of integration ID&#39;s of the alert you want to get

  • :from_date (Time) —

    The start date of the alert you want to get (in YYYY-MM-DD format)

  • :to_date (Time) —

    The end date of the alert you want to get (in YYYY-MM-DD format)

  • :ascending (Boolean)

Returns:

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

    GetAlertsResponse data, response status code and response headers



300
301
302
303
304
305
306
307
308
309
310
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
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 300

def get_alerts_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_alerts_v3 ...'
  end
  allowable_values = ["configuration_drift", "check_degraded", "integration_failure", "Threat"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/saas-security/entities/alerts/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'last_id'] = opts[:'last_id'] if !opts[:'last_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].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] || 'GetAlertsResponse'

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

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

#get_app_inventory(opts = {}) ⇒ AppInventory

GET Applications Inventory Get a list of all apps in the Applications inventory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Comma separated list of app types

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :status (String) —

    Comma separated list of application statuses (approved, in review, rejected, unclassified)

  • :access_level (String) —

    Comma separated list of access levels

  • :scopes (String) —

    Comma separated list of scopes

  • :users (String) —

    Users. Format: &#39;is equal value&#39; or &#39;contains value&#39; or &#39;value&#39; (implies &#39;is equal value&#39;)

  • :groups (String) —

    Comma separated list of groups

  • :last_activity (String) —

    Last activity was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :integration_id (String) —

    Comma separated list of integration IDs

Returns:



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

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

#get_app_inventory_users(item_id, opts = {}) ⇒ AppInventoryUsers

GET Application Users Get users associated with an app from the Applications Inventory

Parameters:

  • item_id (String) —

    Item ID in format: &#39;integration_id|||app_id&#39; (item_id)

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

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 453

def get_app_inventory_users(item_id, opts = {})
  data, _status_code, _headers = get_app_inventory_users_with_http_info(item_id, opts)
  data
end

#get_app_inventory_users_with_http_info(item_id, opts = {}) ⇒ Array<(AppInventoryUsers, Integer, Hash)>

GET Application Users Get users associated with an app from the Applications Inventory

Parameters:

  • item_id (String) —

    Item ID in format: &#39;integration_id|||app_id&#39; (item_id)

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

    the optional parameters

Returns:

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

    AppInventoryUsers data, response status code and response headers



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 463

def get_app_inventory_users_with_http_info(item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_app_inventory_users ...'
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling SaasSecurity.get_app_inventory_users"
  end
  # resource path
  local_var_path = '/saas-security/entities/app-users/v3'

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

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

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

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

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

#get_app_inventory_with_http_info(opts = {}) ⇒ Array<(AppInventory, Integer, Hash)>

GET Applications Inventory Get a list of all apps in the Applications inventory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Comma separated list of app types

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :status (String) —

    Comma separated list of application statuses (approved, in review, rejected, unclassified)

  • :access_level (String) —

    Comma separated list of access levels

  • :scopes (String) —

    Comma separated list of scopes

  • :users (String) —

    Users. Format: &#39;is equal value&#39; or &#39;contains value&#39; or &#39;value&#39; (implies &#39;is equal value&#39;)

  • :groups (String) —

    Comma separated list of groups

  • :last_activity (String) —

    Last activity was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :integration_id (String) —

    Comma separated list of integration IDs

Returns:

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

    AppInventory data, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 390

def get_app_inventory_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_app_inventory ...'
  end
  allowable_values = ["approved", "in review", "rejected", "unclassified"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/saas-security/entities/apps/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'access_level'] = opts[:'access_level'] if !opts[:'access_level'].nil?
  query_params[:'scopes'] = opts[:'scopes'] if !opts[:'scopes'].nil?
  query_params[:'users'] = opts[:'users'] if !opts[:'users'].nil?
  query_params[:'groups'] = opts[:'groups'] if !opts[:'groups'].nil?
  query_params[:'last_activity'] = opts[:'last_activity'] if !opts[:'last_activity'].nil?
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].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] || 'AppInventory'

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

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

#get_asset_inventory_v3(opts = {}) ⇒ GetAssetInventory

GET Data Inventory Get a list of all assets in the Data Inventory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :resource_type (String) —

    Comma separated list of resource types

  • :access_level (String) —

    Comma separated list of access levels

  • :last_accessed (String) —

    Last accessed date was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :last_modified (String) —

    Last modified date was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :resource_name (String) —

    Resource name contains &#39;value&#39; (case insensitive)

  • :password_protected (Boolean) —

    Password protected

  • :resource_owner (String) —

    Resource owner contains &#39;value&#39; (case insensitive)

  • :resource_owner_enabled (Boolean) —

    Resource owner enabled

  • :unmanaged_domain (String) —

    Comma separated list of unmanaged domains

Returns:



528
529
530
531
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 528

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

#get_asset_inventory_v3_with_http_info(opts = {}) ⇒ Array<(GetAssetInventory, Integer, Hash)>

GET Data Inventory Get a list of all assets in the Data Inventory

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :resource_type (String) —

    Comma separated list of resource types

  • :access_level (String) —

    Comma separated list of access levels

  • :last_accessed (String) —

    Last accessed date was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :last_modified (String) —

    Last modified date was within or was not within the last &#39;value&#39; days. Format: &#39;was value&#39; or &#39;was not value&#39; or &#39;value&#39; (implies &#39;was value&#39;). &#39;value&#39; is an integer

  • :resource_name (String) —

    Resource name contains &#39;value&#39; (case insensitive)

  • :password_protected (Boolean) —

    Password protected

  • :resource_owner (String) —

    Resource owner contains &#39;value&#39; (case insensitive)

  • :resource_owner_enabled (Boolean) —

    Resource owner enabled

  • :unmanaged_domain (String) —

    Comma separated list of unmanaged domains

Returns:

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

    GetAssetInventory data, response status code and response headers



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 549

def get_asset_inventory_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_asset_inventory_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/data/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'resource_type'] = opts[:'resource_type'] if !opts[:'resource_type'].nil?
  query_params[:'access_level'] = opts[:'access_level'] if !opts[:'access_level'].nil?
  query_params[:'last_accessed'] = opts[:'last_accessed'] if !opts[:'last_accessed'].nil?
  query_params[:'last_modified'] = opts[:'last_modified'] if !opts[:'last_modified'].nil?
  query_params[:'resource_name'] = opts[:'resource_name'] if !opts[:'resource_name'].nil?
  query_params[:'password_protected'] = opts[:'password_protected'] if !opts[:'password_protected'].nil?
  query_params[:'resource_owner'] = opts[:'resource_owner'] if !opts[:'resource_owner'].nil?
  query_params[:'resource_owner_enabled'] = opts[:'resource_owner_enabled'] if !opts[:'resource_owner_enabled'].nil?
  query_params[:'unmanaged_domain'] = opts[:'unmanaged_domain'] if !opts[:'unmanaged_domain'].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] || 'GetAssetInventory'

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

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

#get_device_inventory_v3(opts = {}) ⇒ GetDeviceInventory

GET Device Inventory Get a list of all devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated integration ID&#39;s

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :email (String) —

    Email

  • :privileged_only (Boolean) —

    Privileged Only

  • :unassociated_devices (Boolean) —

    Unassociated Devices

Returns:



615
616
617
618
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 615

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

#get_device_inventory_v3_with_http_info(opts = {}) ⇒ Array<(GetDeviceInventory, Integer, Hash)>

GET Device Inventory Get a list of all devices

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated integration ID&#39;s

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :email (String) —

    Email

  • :privileged_only (Boolean) —

    Privileged Only

  • :unassociated_devices (Boolean) —

    Unassociated Devices

Returns:

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

    GetDeviceInventory data, response status code and response headers



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
677
678
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 630

def get_device_inventory_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_device_inventory_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/devices/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'privileged_only'] = opts[:'privileged_only'] if !opts[:'privileged_only'].nil?
  query_params[:'unassociated_devices'] = opts[:'unassociated_devices'] if !opts[:'unassociated_devices'].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] || 'GetDeviceInventory'

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

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

#get_integrations_v3(opts = {}) ⇒ GetIntegrations

GET Integrations Get a list of connected integrations in your account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :saas_id (String) —

    Comma separated SaaS ID&#39;s

Returns:



685
686
687
688
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 685

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

#get_integrations_v3_with_http_info(opts = {}) ⇒ Array<(GetIntegrations, Integer, Hash)>

GET Integrations Get a list of connected integrations in your account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :saas_id (String) —

    Comma separated SaaS ID&#39;s

Returns:

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

    GetIntegrations data, response status code and response headers



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/saas_security.rb', line 695

def get_integrations_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_integrations_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/integrations/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'saas_id'] = opts[:'saas_id'] if !opts[:'saas_id'].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] || 'GetIntegrations'

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

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

#get_metrics_v3(opts = {}) ⇒ GetMetrics

GET Metrics Get metrics on security checks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Exposure status

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :impact (String) —

    Impact

  • :compliance (Boolean) —

    Compliance

  • :check_type (String) —

    Check Type

Returns:



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

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

#get_metrics_v3_with_http_info(opts = {}) ⇒ Array<(GetMetrics, Integer, Hash)>

GET Metrics Get metrics on security checks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Exposure status

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :impact (String) —

    Impact

  • :compliance (Boolean) —

    Compliance

  • :check_type (String) —

    Check Type

Returns:

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

    GetMetrics data, response status code and response headers



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
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 767

def get_metrics_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_metrics_v3 ...'
  end
  allowable_values = ["Passed", "Failed", "Dismissed", "Pending", "Can't Run", "Stale"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ["1", "2", "3"]
  if @api_client.config.client_side_validation && opts[:'impact'] && !allowable_values.include?(opts[:'impact'])
    fail ArgumentError, "invalid value for \"impact\", must be one of #{allowable_values}"
  end
  allowable_values = ["apps", "devices", "users", "assets", "permissions", "Falcon Shield Security Check", "custom"]
  if @api_client.config.client_side_validation && opts[:'check_type'] && !allowable_values.include?(opts[:'check_type'])
    fail ArgumentError, "invalid value for \"check_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/saas-security/aggregates/check-metrics/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'impact'] = opts[:'impact'] if !opts[:'impact'].nil?
  query_params[:'compliance'] = opts[:'compliance'] if !opts[:'compliance'].nil?
  query_params[:'check_type'] = opts[:'check_type'] if !opts[:'check_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] || 'GetMetrics'

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

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

#get_security_check_affected_v3(id, opts = {}) ⇒ GetAffected

GET Security Check Affected Get a list of affected entities

Parameters:

  • id (String) —

    Security Check ID

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

Returns:



837
838
839
840
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 837

def get_security_check_affected_v3(id, opts = {})
  data, _status_code, _headers = get_security_check_affected_v3_with_http_info(id, opts)
  data
end

#get_security_check_affected_v3_with_http_info(id, opts = {}) ⇒ Array<(GetAffected, Integer, Hash)>

GET Security Check Affected Get a list of affected entities

Parameters:

  • id (String) —

    Security Check ID

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

Returns:

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

    GetAffected data, response status code and response headers



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 849

def get_security_check_affected_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_security_check_affected_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.get_security_check_affected_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/check-affected/v3'

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

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

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

#get_security_check_compliance_v3(id, opts = {}) ⇒ GetSecurityCompliance

GET Compliance Get a list of compliance standards attached to a check

Parameters:

  • id (String) —

    Security Check ID

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

    the optional parameters

Returns:



905
906
907
908
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 905

def get_security_check_compliance_v3(id, opts = {})
  data, _status_code, _headers = get_security_check_compliance_v3_with_http_info(id, opts)
  data
end

#get_security_check_compliance_v3_with_http_info(id, opts = {}) ⇒ Array<(GetSecurityCompliance, Integer, Hash)>

GET Compliance Get a list of compliance standards attached to a check

Parameters:

  • id (String) —

    Security Check ID

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

    the optional parameters

Returns:

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

    GetSecurityCompliance data, response status code and response headers



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
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 915

def get_security_check_compliance_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_security_check_compliance_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.get_security_check_compliance_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/compliance/v3'

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

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

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

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

#get_security_checks_v3(opts = {}) ⇒ GetSecurityChecks

GET Security Check by ID or GET List Security Checks Get a specific security check by ID or Get all security checks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Security Check ID

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :status (String) —

    Exposure status

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :impact (String) —

    Impact

  • :compliance (Boolean) —

    Compliance

  • :check_type (String) —

    Check Type

  • :check_tags (String) —

    Comma separated list of check tags names or ids

Returns:



977
978
979
980
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 977

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

#get_security_checks_v3_with_http_info(opts = {}) ⇒ Array<(GetSecurityChecks, Integer, Hash)>

GET Security Check by ID or GET List Security Checks Get a specific security check by ID or Get all security checks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Security Check ID

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :status (String) —

    Exposure status

  • :integration_id (String) —

    Comma separated list of integration IDs

  • :impact (String) —

    Impact

  • :compliance (Boolean) —

    Compliance

  • :check_type (String) —

    Check Type

  • :check_tags (String) —

    Comma separated list of check tags names or ids

Returns:

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

    GetSecurityChecks data, response status code and response headers



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 995

def get_security_checks_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_security_checks_v3 ...'
  end
  allowable_values = ["Passed", "Failed", "Dismissed", "Pending", "Can't Run", "Stale"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ["Low", "Medium", "High"]
  if @api_client.config.client_side_validation && opts[:'impact'] && !allowable_values.include?(opts[:'impact'])
    fail ArgumentError, "invalid value for \"impact\", must be one of #{allowable_values}"
  end
  allowable_values = ["apps", "devices", "users", "assets", "permissions", "Falcon Shield Security Check", "custom"]
  if @api_client.config.client_side_validation && opts[:'check_type'] && !allowable_values.include?(opts[:'check_type'])
    fail ArgumentError, "invalid value for \"check_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/saas-security/entities/checks/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'impact'] = opts[:'impact'] if !opts[:'impact'].nil?
  query_params[:'compliance'] = opts[:'compliance'] if !opts[:'compliance'].nil?
  query_params[:'check_type'] = opts[:'check_type'] if !opts[:'check_type'].nil?
  query_params[:'check_tags'] = opts[:'check_tags'] if !opts[:'check_tags'].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] || 'GetSecurityChecks'

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

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

#get_supported_saas_v3(opts = {}) ⇒ GetSupportedSaas

GET Supported SaaS Get a list of supported integrations

Parameters:

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

    the optional parameters

Returns:



1064
1065
1066
1067
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1064

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

#get_supported_saas_v3_with_http_info(opts = {}) ⇒ Array<(GetSupportedSaas, Integer, Hash)>

GET Supported SaaS Get a list of supported integrations

Parameters:

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

    the optional parameters

Returns:

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

    GetSupportedSaas data, response status code and response headers



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1073

def get_supported_saas_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_supported_saas_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/supported-saas/v3'

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

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

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

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

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

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

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

#get_system_logs_v3(opts = {}) ⇒ GetSystemLogs

GET System Logs Get a list of all system logs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from_date (Time) —

    From Date (in YYYY-MM-DD format)

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :to_date (Time) —

    To Date (in YYYY-MM-DD format)

  • :total_count (Boolean) —

    Fetch Total Count?

Returns:



1126
1127
1128
1129
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1126

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

#get_system_logs_v3_with_http_info(opts = {}) ⇒ Array<(GetSystemLogs, Integer, Hash)>

GET System Logs Get a list of all system logs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from_date (Time) —

    From Date (in YYYY-MM-DD format)

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :to_date (Time) —

    To Date (in YYYY-MM-DD format)

  • :total_count (Boolean) —

    Fetch Total Count?

Returns:

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

    GetSystemLogs data, response status code and response headers



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

def get_system_logs_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_system_logs_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/system-logs/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'total_count'] = opts[:'total_count'] if !opts[:'total_count'].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] || 'GetSystemLogs'

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

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

#get_system_users_v3(opts = {}) ⇒ GetSystemUsers

GET System Users Get a list of system users

Parameters:

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

    the optional parameters

Returns:



1193
1194
1195
1196
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1193

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

#get_system_users_v3_with_http_info(opts = {}) ⇒ Array<(GetSystemUsers, Integer, Hash)>

GET System Users Get a list of system users

Parameters:

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

    the optional parameters

Returns:

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

    GetSystemUsers data, response status code and response headers



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1202

def get_system_users_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_system_users_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/system-users/v3'

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

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

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

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

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

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

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

#get_user_inventory_v3(opts = {}) ⇒ GetUserInventory

GET User Inventory Get a list of all users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated integration ID&#39;s

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :email (String) —

    Email

  • :privileged_only (Boolean) —

    Privileged Only

Returns:



1255
1256
1257
1258
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1255

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

#get_user_inventory_v3_with_http_info(opts = {}) ⇒ Array<(GetUserInventory, Integer, Hash)>

GET User Inventory Get a list of all users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :integration_id (String) —

    Comma separated integration ID&#39;s

  • :limit (Integer) —

    The maximum number of objects to return

  • :offset (Integer) —

    The starting index of the results

  • :email (String) —

    Email

  • :privileged_only (Boolean) —

    Privileged Only

Returns:

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

    GetUserInventory data, response status code and response headers



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

def get_user_inventory_v3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.get_user_inventory_v3 ...'
  end
  # resource path
  local_var_path = '/saas-security/entities/users/v3'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'integration_id'] = opts[:'integration_id'] if !opts[:'integration_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'privileged_only'] = opts[:'privileged_only'] if !opts[:'privileged_only'].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] || 'GetUserInventory'

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

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

#integration_builder_end_transaction_v3(id, opts = {}) ⇒ GetEndTransaction

POST Data Upload Transaction Completion Make a close transaction call after uploading the data

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



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

def integration_builder_end_transaction_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_end_transaction_v3_with_http_info(id, opts)
  data
end

#integration_builder_end_transaction_v3_with_http_info(id, opts = {}) ⇒ Array<(GetEndTransaction, Integer, Hash)>

POST Data Upload Transaction Completion Make a close transaction call after uploading the data

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetEndTransaction data, response status code and response headers



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

def integration_builder_end_transaction_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.integration_builder_end_transaction_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.integration_builder_end_transaction_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-close/v3'

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

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

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

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

#integration_builder_get_status_v3(id, opts = {}) ⇒ GetTransactionStatus

GET Status Get transaction status for a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



1387
1388
1389
1390
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1387

def integration_builder_get_status_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_get_status_v3_with_http_info(id, opts)
  data
end

#integration_builder_get_status_v3_with_http_info(id, opts = {}) ⇒ Array<(GetTransactionStatus, Integer, Hash)>

GET Status Get transaction status for a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetTransactionStatus data, response status code and response headers



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

def integration_builder_get_status_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.integration_builder_get_status_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.integration_builder_get_status_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-status/v3'

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

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

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

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

#integration_builder_reset_v3(id, opts = {}) ⇒ GetTransactionStatus

Reset Make a reset call to a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:



1451
1452
1453
1454
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1451

def integration_builder_reset_v3(id, opts = {})
  data, _status_code, _headers = integration_builder_reset_v3_with_http_info(id, opts)
  data
end

#integration_builder_reset_v3_with_http_info(id, opts = {}) ⇒ Array<(GetTransactionStatus, Integer, Hash)>

Reset Make a reset call to a custom integration

Parameters:

  • id (String) —

    Integration ID

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

    the optional parameters

Returns:

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

    GetTransactionStatus data, response status code and response headers



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

def integration_builder_reset_v3_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.integration_builder_reset_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.integration_builder_reset_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-reset/v3'

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

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

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

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

#integration_builder_upload_v3(id, source_id, body, opts = {}) ⇒ UploadDataResponse

POST Upload Send data to a specific source in a custom integration

Parameters:

  • id (String) —

    Integration ID

  • source_id (String) —

    Source ID

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

    the optional parameters

Returns:



1517
1518
1519
1520
 
# File 'lib/crimson-falcon/api/saas_security.rb', line 1517

def integration_builder_upload_v3(id, source_id, body, opts = {})
  data, _status_code, _headers = integration_builder_upload_v3_with_http_info(id, source_id, body, opts)
  data
end

#integration_builder_upload_v3_with_http_info(id, source_id, body, opts = {}) ⇒ Array<(UploadDataResponse, Integer, Hash)>

POST Upload Send data to a specific source in a custom integration

Parameters:

  • id (String) —

    Integration ID

  • source_id (String) —

    Source ID

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

    the optional parameters

Returns:

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

    UploadDataResponse data, response status code and response headers



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

def integration_builder_upload_v3_with_http_info(id, source_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SaasSecurity.integration_builder_upload_v3 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SaasSecurity.integration_builder_upload_v3"
  end
  # verify the required parameter 'source_id' is set
  if @api_client.config.client_side_validation && source_id.nil?
    fail ArgumentError, "Missing the required parameter 'source_id' when calling SaasSecurity.integration_builder_upload_v3"
  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 SaasSecurity.integration_builder_upload_v3"
  end
  # resource path
  local_var_path = '/saas-security/entities/custom-integration-upload/v3'

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

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

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

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