Class: Falcon::CloudSecurityAssets

Inherits:

Object

Object
Falcon::CloudSecurityAssets

show all

Defined in:: lib/crimson-falcon/api/cloud_security_assets.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#cloud_security_assets_combined_application_findings(type, opts = {}) ⇒ AssetsGetResourceApplicationFindingsResponse

Get findings for an application resource with pagination.
#cloud_security_assets_combined_application_findings_with_http_info(type, opts = {}) ⇒ Array<(AssetsGetResourceApplicationFindingsResponse, Integer, Hash)>

Get findings for an application resource with pagination.
#cloud_security_assets_combined_compliance_by_account(opts = {}) ⇒ AssetsComplianceResponse

Gets combined compliance data aggregated by account and region.
#cloud_security_assets_combined_compliance_by_account_with_http_info(opts = {}) ⇒ Array<(AssetsComplianceResponse, Integer, Hash)>

Gets combined compliance data aggregated by account and region.
#cloud_security_assets_entities_get(opts = {}) ⇒ AssetsGetResourcesResponse

Gets raw resources based on the provided IDs param.
#cloud_security_assets_entities_get_with_http_info(opts = {}) ⇒ Array<(AssetsGetResourcesResponse, Integer, Hash)>

Gets raw resources based on the provided IDs param.
#cloud_security_assets_queries(opts = {}) ⇒ AssetsGetResourceIDsResponse

Gets a list of resource IDs for the given parameters, filters and sort criteria.
#cloud_security_assets_queries_with_http_info(opts = {}) ⇒ Array<(AssetsGetResourceIDsResponse, Integer, Hash)>

Gets a list of resource IDs for the given parameters, filters and sort criteria.
#initialize(api_client = ApiClient.default) ⇒ CloudSecurityAssets constructor

A new instance of CloudSecurityAssets.

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ `CloudSecurityAssets`

Returns a new instance of CloudSecurityAssets.



35
36
37

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 35

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

Instance Attribute Details

#api_client ⇒ `Object`

Returns the value of attribute api_client.



33
34
35

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#cloud_security_assets_combined_application_findings(type, opts = {}) ⇒ `AssetsGetResourceApplicationFindingsResponse`

Get findings for an application resource with pagination

Parameters:

type (String) —

Finding type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:crn (String) —

Deprecated: Use 'gcrn' instead. Application CRN
:gcrn (String) —

Application GCRN
:filter (String) —

FQL string to filter findings
:offset (Integer) —

Pagination offset (default to 0)
:limit (Integer) —

Page size (default to 50)

Returns:

(AssetsGetResourceApplicationFindingsResponse)

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 47

def cloud_security_assets_combined_application_findings(type, opts = {})
  data, _status_code, _headers = cloud_security_assets_combined_application_findings_with_http_info(type, opts)
  data
end

#cloud_security_assets_combined_application_findings_with_http_info(type, opts = {}) ⇒ `Array<(AssetsGetResourceApplicationFindingsResponse, Integer, Hash)>`

Get findings for an application resource with pagination

Parameters:

type (String) —

Finding type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:crn (String) —

Deprecated: Use 'gcrn' instead. Application CRN
:gcrn (String) —

Application GCRN
:filter (String) —

FQL string to filter findings
:offset (Integer) —

Pagination offset (default to 0)
:limit (Integer) —

Page size (default to 50)

Returns:

(Array<(AssetsGetResourceApplicationFindingsResponse, Integer, Hash)>) —

AssetsGetResourceApplicationFindingsResponse data, response status code and response headers

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 61

def cloud_security_assets_combined_application_findings_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityAssets.cloud_security_assets_combined_application_findings ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling CloudSecurityAssets.cloud_security_assets_combined_application_findings"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CloudSecurityAssets.cloud_security_assets_combined_application_findings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_combined_application_findings, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_combined_application_findings, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/cloud-security-assets/combined/application-findings/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'crn'] = opts[:'crn'] if !opts[:'crn'].nil?
  query_params[:'gcrn'] = opts[:'gcrn'] if !opts[:'gcrn'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'AssetsGetResourceApplicationFindingsResponse'

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

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

#cloud_security_assets_combined_compliance_by_account(opts = {}) ⇒ `AssetsComplianceResponse`

Gets combined compliance data aggregated by account and region. Results can be filtered and sorted.

Parameters:

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

the optional parameters

Options Hash (opts):

:filter (String) —

FQL string to filter on asset contents. Filterable fields include: - `account_id` - `account_name` - `assessment_id` - `business_impact` - `cloud_group` - `cloud_label` - `cloud_label_id` - `cloud_provider` - `cloud_scope` - `compliant` - `control.benchmark.name` - `control.benchmark.version` - `control.extension.status` - `control.framework` - `control.name` - `control.type` - `control.version` - `environment` - `last_evaluated` - `region` - `resource_gcrn` - `resource_provider` - `resource_type` - `resource_type_name` - `service` - `service_category` - `severities` - `tag_key` - `tag_value` - `tags_string`
:sort (String) —

Sort expression in format: field|direction (e.g., last_evaluated|desc). Allowed sort fields: - `account_id` - `account_name` - `assessment_id` - `cloud_provider` - `control.benchmark.name` - `control.benchmark.version` - `control.framework` - `control.name` - `control.type` - `control.version` - `last_evaluated` - `region` - `resource_counts.compliant` - `resource_counts.non_compliant` - `resource_counts.total` - `resource_provider` - `resource_type` - `resource_type_name` - `service` - `service_category`
:limit (Integer) —

The maximum number of items to return. When not specified or 0, 20 is used. When larger than 10000, 10000 is used. (default to 20)
:offset (Integer) —

Offset returned controls. Use only one of 'offset' and 'after' parameter for paginating. 'offset' can only be used on offsets < 10,000. For paginating through the entire result set, use 'after' parameter
:after (String) —

token-based pagination. use for paginating through an entire result set. Use only one of 'offset' and 'after' parameters for paginating
:include_failing_iom_severity_counts (Boolean) —

Include counts of failing IOMs by severity level (default to false)

Returns:

(AssetsComplianceResponse)

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 136

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

#cloud_security_assets_combined_compliance_by_account_with_http_info(opts = {}) ⇒ `Array<(AssetsComplianceResponse, Integer, Hash)>`

Gets combined compliance data aggregated by account and region. Results can be filtered and sorted.

Parameters:

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

the optional parameters

Options Hash (opts):

:filter (String) —

FQL string to filter on asset contents. Filterable fields include: - `account_id` - `account_name` - `assessment_id` - `business_impact` - `cloud_group` - `cloud_label` - `cloud_label_id` - `cloud_provider` - `cloud_scope` - `compliant` - `control.benchmark.name` - `control.benchmark.version` - `control.extension.status` - `control.framework` - `control.name` - `control.type` - `control.version` - `environment` - `last_evaluated` - `region` - `resource_gcrn` - `resource_provider` - `resource_type` - `resource_type_name` - `service` - `service_category` - `severities` - `tag_key` - `tag_value` - `tags_string`
:sort (String) —

Sort expression in format: field|direction (e.g., last_evaluated|desc). Allowed sort fields: - `account_id` - `account_name` - `assessment_id` - `cloud_provider` - `control.benchmark.name` - `control.benchmark.version` - `control.framework` - `control.name` - `control.type` - `control.version` - `last_evaluated` - `region` - `resource_counts.compliant` - `resource_counts.non_compliant` - `resource_counts.total` - `resource_provider` - `resource_type` - `resource_type_name` - `service` - `service_category`
:limit (Integer) —

The maximum number of items to return. When not specified or 0, 20 is used. When larger than 10000, 10000 is used. (default to 20)
:offset (Integer) —

Offset returned controls. Use only one of 'offset' and 'after' parameter for paginating. 'offset' can only be used on offsets < 10,000. For paginating through the entire result set, use 'after' parameter
:after (String) —

token-based pagination. use for paginating through an entire result set. Use only one of 'offset' and 'after' parameters for paginating
:include_failing_iom_severity_counts (Boolean) —

Include counts of failing IOMs by severity level (default to false)

Returns:

(Array<(AssetsComplianceResponse, Integer, Hash)>) —

AssetsComplianceResponse data, response status code and response headers

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 150

def cloud_security_assets_combined_compliance_by_account_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityAssets.cloud_security_assets_combined_compliance_by_account ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_combined_compliance_by_account, must be smaller than or equal to 10000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_combined_compliance_by_account, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 9999
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CloudSecurityAssets.cloud_security_assets_combined_compliance_by_account, must be smaller than or equal to 9999.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CloudSecurityAssets.cloud_security_assets_combined_compliance_by_account, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/cloud-security-assets/combined/compliance-controls/by-account-region-and-resource-type/v1'

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

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

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

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

#cloud_security_assets_entities_get(opts = {}) ⇒ `AssetsGetResourcesResponse`

Gets raw resources based on the provided IDs param. Maximum of 100 resources can be requested with this method. Use POST method with same path if more are required.

Parameters:

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

the optional parameters

Options Hash (opts):

:ids (Array<String>) —

List of assets to return (maximum 100 IDs allowed). Use POST method with same path if more entities are required.

Returns:

(AssetsGetResourcesResponse)

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 220

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

#cloud_security_assets_entities_get_with_http_info(opts = {}) ⇒ `Array<(AssetsGetResourcesResponse, Integer, Hash)>`

Gets raw resources based on the provided IDs param. Maximum of 100 resources can be requested with this method. Use POST method with same path if more are required.

Parameters:

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

the optional parameters

Options Hash (opts):

:ids (Array<String>) —

List of assets to return (maximum 100 IDs allowed). Use POST method with same path if more entities are required.

Returns:

(Array<(AssetsGetResourcesResponse, Integer, Hash)>) —

AssetsGetResourcesResponse data, response status code and response headers

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 229

def cloud_security_assets_entities_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityAssets.cloud_security_assets_entities_get ...'
  end
  # resource path
  local_var_path = '/cloud-security-assets/entities/resources/v1'

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

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

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

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

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

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

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

#cloud_security_assets_queries(opts = {}) ⇒ `AssetsGetResourceIDsResponse`

Gets a list of resource IDs for the given parameters, filters and sort criteria

Parameters:

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

the optional parameters

Options Hash (opts):

:after (String) —

token-based pagination. use for paginating through an entire result set. Use only one of 'offset' and 'after' parameters for paginating
:filter (String) —

FQL string to filter on asset contents. Filterable fields include: - `account_id` - `account_name` - `active` - `aspm.deployment_cloud_resource_id` - `aspm.deployment_provider` - `aspm.deployment_type` - `aspm.technologies` - `azure.resource_group` - `azure.vm_id` - `business_impact` - `cloud_group` - `cloud_label` - `cloud_label_id` - `cloud_provider` - `cloud_risks.rule` - `cloud_risks.severity` - `cloud_risks.status` - `cloud_scope` - `cluster_id` - `cluster_name` - `compartment_ocid` - `compliant.benchmark_name` - `compliant.benchmark_version` - `compliant.framework` - `compliant.policy_id` - `compliant.requirement` - `compliant.rule` - `compliant.section` - `configuration.id` - `control.benchmark.name` - `control.benchmark.version` - `control.framework` - `control.requirement` - `control.type` - `control.version` - `creation_time` - `cve_ids` - `data_classifications.found` - `data_classifications.label` - `data_classifications.label_id` - `data_classifications.scanned` - `data_classifications.tag` - `data_classifications.tag_id` - `environment` - `exprt_ratings` - `first_seen` - `highest_severity` - `id` - `insights.boolean_value` - `insights.date_value` - `insights.id` - `insights.integer_value` - `insights.string_list_value` - `insights.string_value` - `instance_id` - `instance_state` - `ioa_count` - `iom_count` - `legacy_resource_id` - `legacy_uuid` - `managed_by` - `non_compliant.benchmark_name` - `non_compliant.benchmark_version` - `non_compliant.framework` - `non_compliant.policy_id` - `non_compliant.requirement` - `non_compliant.rule` - `non_compliant.rule_name` - `non_compliant.section` - `non_compliant.severity` - `organization_Id` - `os_version` - `platform_name` - `publicly_exposed` - `region` - `resource_gcrn` - `resource_id` - `resource_name` - `resource_parent` - `resource_type` - `resource_type_name` - `sensor_priority` - `service` - `service_category` - `severity` - `snapshot_detections` - `ssm_managed` - `status` - `tag_key` - `tag_value` - `tags` - `tags_string` - `tenant_id` - `updated_at` - `vmware.guest_os_id` - `vmware.guest_os_version` - `vmware.host_system_name` - `vmware.host_type` - `vmware.instance_uuid` - `vmware.vm_host_name` - `vmware.vm_tools_status` - `zone`
:sort (String) —

The field to sort on. Sortable fields include: - `account_id` - `account_name` - `active` - `aspm.deployment_cloud_resource_id` - `aspm.deployment_provider` - `aspm.deployment_type` - `aspm.exprt_rating` - `aspm.technologies` - `cloud_provider` - `cloud_risks.open_risk_count` - `cluster_id` - `cluster_name` - `compartment_name` - `compartment_ocid` - `compartment_path` - `creation_time` - `data_classifications.found` - `data_classifications.scanned` - `first_seen` - `id` - `instance_id` - `instance_state` - `ioa_count` - `iom_count` - `managed_by` - `organization_Id` - `os_version` - `platform_name` - `publicly_exposed` - `region` - `resource_id` - `resource_name` - `resource_parent` - `resource_type` - `resource_type_name` - `service` - `service_category` - `ssm_managed` - `status` - `tenancy_name` - `tenancy_ocid` - `tenancy_type` - `tenant_id` - `updated_at` - `vmware.guest_os_id` - `vmware.guest_os_version` - `vmware.host_system_name` - `vmware.host_type` - `vmware.instance_uuid` - `vmware.vm_host_name` - `vmware.vm_tools_status` - `zone` - `publiclyExposedToTheInternet` - `publiclyExposedAccessRange` - `publiclyExposedExposureMethod` Use `|asc` or `|desc` suffix to specify sort direction.
:limit (Integer) —

The maximum number of items to return. When not specified or 0, 500 is used. When larger than 1000, 1000 is used. (default to 500)
:offset (Integer) —

Offset returned assets. Use only one of 'offset' and 'after' parameter for paginating. 'offset' can only be used on offsets < 10,000. For paginating through the entire result set, use 'after' parameter

Returns:

(AssetsGetResourceIDsResponse)

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 282

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

#cloud_security_assets_queries_with_http_info(opts = {}) ⇒ `Array<(AssetsGetResourceIDsResponse, Integer, Hash)>`

Gets a list of resource IDs for the given parameters, filters and sort criteria

Parameters:

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

the optional parameters

Options Hash (opts):

:after (String) —

token-based pagination. use for paginating through an entire result set. Use only one of 'offset' and 'after' parameters for paginating
:filter (String) —

FQL string to filter on asset contents. Filterable fields include: - `account_id` - `account_name` - `active` - `aspm.deployment_cloud_resource_id` - `aspm.deployment_provider` - `aspm.deployment_type` - `aspm.technologies` - `azure.resource_group` - `azure.vm_id` - `business_impact` - `cloud_group` - `cloud_label` - `cloud_label_id` - `cloud_provider` - `cloud_risks.rule` - `cloud_risks.severity` - `cloud_risks.status` - `cloud_scope` - `cluster_id` - `cluster_name` - `compartment_ocid` - `compliant.benchmark_name` - `compliant.benchmark_version` - `compliant.framework` - `compliant.policy_id` - `compliant.requirement` - `compliant.rule` - `compliant.section` - `configuration.id` - `control.benchmark.name` - `control.benchmark.version` - `control.framework` - `control.requirement` - `control.type` - `control.version` - `creation_time` - `cve_ids` - `data_classifications.found` - `data_classifications.label` - `data_classifications.label_id` - `data_classifications.scanned` - `data_classifications.tag` - `data_classifications.tag_id` - `environment` - `exprt_ratings` - `first_seen` - `highest_severity` - `id` - `insights.boolean_value` - `insights.date_value` - `insights.id` - `insights.integer_value` - `insights.string_list_value` - `insights.string_value` - `instance_id` - `instance_state` - `ioa_count` - `iom_count` - `legacy_resource_id` - `legacy_uuid` - `managed_by` - `non_compliant.benchmark_name` - `non_compliant.benchmark_version` - `non_compliant.framework` - `non_compliant.policy_id` - `non_compliant.requirement` - `non_compliant.rule` - `non_compliant.rule_name` - `non_compliant.section` - `non_compliant.severity` - `organization_Id` - `os_version` - `platform_name` - `publicly_exposed` - `region` - `resource_gcrn` - `resource_id` - `resource_name` - `resource_parent` - `resource_type` - `resource_type_name` - `sensor_priority` - `service` - `service_category` - `severity` - `snapshot_detections` - `ssm_managed` - `status` - `tag_key` - `tag_value` - `tags` - `tags_string` - `tenant_id` - `updated_at` - `vmware.guest_os_id` - `vmware.guest_os_version` - `vmware.host_system_name` - `vmware.host_type` - `vmware.instance_uuid` - `vmware.vm_host_name` - `vmware.vm_tools_status` - `zone`
:sort (String) —

The field to sort on. Sortable fields include: - `account_id` - `account_name` - `active` - `aspm.deployment_cloud_resource_id` - `aspm.deployment_provider` - `aspm.deployment_type` - `aspm.exprt_rating` - `aspm.technologies` - `cloud_provider` - `cloud_risks.open_risk_count` - `cluster_id` - `cluster_name` - `compartment_name` - `compartment_ocid` - `compartment_path` - `creation_time` - `data_classifications.found` - `data_classifications.scanned` - `first_seen` - `id` - `instance_id` - `instance_state` - `ioa_count` - `iom_count` - `managed_by` - `organization_Id` - `os_version` - `platform_name` - `publicly_exposed` - `region` - `resource_id` - `resource_name` - `resource_parent` - `resource_type` - `resource_type_name` - `service` - `service_category` - `ssm_managed` - `status` - `tenancy_name` - `tenancy_ocid` - `tenancy_type` - `tenant_id` - `updated_at` - `vmware.guest_os_id` - `vmware.guest_os_version` - `vmware.host_system_name` - `vmware.host_type` - `vmware.instance_uuid` - `vmware.vm_host_name` - `vmware.vm_tools_status` - `zone` - `publiclyExposedToTheInternet` - `publiclyExposedAccessRange` - `publiclyExposedExposureMethod` Use `|asc` or `|desc` suffix to specify sort direction.
:limit (Integer) —

The maximum number of items to return. When not specified or 0, 500 is used. When larger than 1000, 1000 is used. (default to 500)
:offset (Integer) —

Offset returned assets. Use only one of 'offset' and 'after' parameter for paginating. 'offset' can only be used on offsets < 10,000. For paginating through the entire result set, use 'after' parameter

Returns:

(Array<(AssetsGetResourceIDsResponse, Integer, Hash)>) —

AssetsGetResourceIDsResponse data, response status code and response headers

# File 'lib/crimson-falcon/api/cloud_security_assets.rb', line 295

def cloud_security_assets_queries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityAssets.cloud_security_assets_queries ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_queries, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudSecurityAssets.cloud_security_assets_queries, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling CloudSecurityAssets.cloud_security_assets_queries, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/cloud-security-assets/queries/resources/v1'

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

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

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

Class: Falcon::CloudSecurityAssets

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudSecurityAssets

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#cloud_security_assets_combined_application_findings(type, opts = {}) ⇒ AssetsGetResourceApplicationFindingsResponse

#cloud_security_assets_combined_application_findings_with_http_info(type, opts = {}) ⇒ Array<(AssetsGetResourceApplicationFindingsResponse, Integer, Hash)>

#cloud_security_assets_combined_compliance_by_account(opts = {}) ⇒ AssetsComplianceResponse

#cloud_security_assets_combined_compliance_by_account_with_http_info(opts = {}) ⇒ Array<(AssetsComplianceResponse, Integer, Hash)>

#cloud_security_assets_entities_get(opts = {}) ⇒ AssetsGetResourcesResponse

#cloud_security_assets_entities_get_with_http_info(opts = {}) ⇒ Array<(AssetsGetResourcesResponse, Integer, Hash)>

#cloud_security_assets_queries(opts = {}) ⇒ AssetsGetResourceIDsResponse

#cloud_security_assets_queries_with_http_info(opts = {}) ⇒ Array<(AssetsGetResourceIDsResponse, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `CloudSecurityAssets`

#api_client ⇒ `Object`

#cloud_security_assets_combined_application_findings(type, opts = {}) ⇒ `AssetsGetResourceApplicationFindingsResponse`

#cloud_security_assets_combined_application_findings_with_http_info(type, opts = {}) ⇒ `Array<(AssetsGetResourceApplicationFindingsResponse, Integer, Hash)>`

#cloud_security_assets_combined_compliance_by_account(opts = {}) ⇒ `AssetsComplianceResponse`

#cloud_security_assets_combined_compliance_by_account_with_http_info(opts = {}) ⇒ `Array<(AssetsComplianceResponse, Integer, Hash)>`

#cloud_security_assets_entities_get(opts = {}) ⇒ `AssetsGetResourcesResponse`

#cloud_security_assets_entities_get_with_http_info(opts = {}) ⇒ `Array<(AssetsGetResourcesResponse, Integer, Hash)>`

#cloud_security_assets_queries(opts = {}) ⇒ `AssetsGetResourceIDsResponse`

#cloud_security_assets_queries_with_http_info(opts = {}) ⇒ `Array<(AssetsGetResourceIDsResponse, Integer, Hash)>`