Class: Falcon::CloudSecurityCompliance

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudSecurityCompliance

Returns a new instance of CloudSecurityCompliance.



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

def api_client
  @api_client
end

Instance Method Details

#cloud_compliance_framework_posture_summaries(ids, opts = {}) ⇒ ComplianceFrameworkPostureSummaryResponse

Get sections and requirements with scores for benchmarks.

Parameters:

  • ids (Array<String>) —

    The uuids of compliance frameworks to retrieve (maximum 20 IDs allowed).

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, supported properties: - &#x60;account_id&#x60; - &#x60;account_name&#x60; - &#x60;business_impact&#x60; - &#x60;cloud_label&#x60; - &#x60;cloud_label_id&#x60; - &#x60;cloud_provider&#x60; - &#x60;environment&#x60; - &#x60;groups&#x60; - &#x60;region&#x60; - &#x60;resource_type&#x60; - &#x60;resource_type_name&#x60; - &#x60;tag_key&#x60; - &#x60;tag_value&#x60; - &#x60;tags_string&#x60;

Returns:



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

def cloud_compliance_framework_posture_summaries(ids, opts = {})
  data, _status_code, _headers = cloud_compliance_framework_posture_summaries_with_http_info(ids, opts)
  data
end

#cloud_compliance_framework_posture_summaries_with_http_info(ids, opts = {}) ⇒ Array<(ComplianceFrameworkPostureSummaryResponse, Integer, Hash)>

Get sections and requirements with scores for benchmarks.

Parameters:

  • ids (Array<String>) —

    The uuids of compliance frameworks to retrieve (maximum 20 IDs allowed).

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, supported properties: - &#x60;account_id&#x60; - &#x60;account_name&#x60; - &#x60;business_impact&#x60; - &#x60;cloud_label&#x60; - &#x60;cloud_label_id&#x60; - &#x60;cloud_provider&#x60; - &#x60;environment&#x60; - &#x60;groups&#x60; - &#x60;region&#x60; - &#x60;resource_type&#x60; - &#x60;resource_type_name&#x60; - &#x60;tag_key&#x60; - &#x60;tag_value&#x60; - &#x60;tags_string&#x60;

Returns:



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

def cloud_compliance_framework_posture_summaries_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityCompliance.cloud_compliance_framework_posture_summaries ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CloudSecurityCompliance.cloud_compliance_framework_posture_summaries"
  end
  if @api_client.config.client_side_validation && ids.length > 20
    fail ArgumentError, 'invalid value for "ids" when calling CloudSecurityCompliance.cloud_compliance_framework_posture_summaries, number of items must be less than or equal to 20.'
  end

  # resource path
  local_var_path = '/cloud-security-compliance/entities/framework-posture-summaries/v1'

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

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

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

#cloud_compliance_rule_posture_summaries(ids, opts = {}) ⇒ ComplianceRulePostureSummaryResponse

Get compliance score and counts for rules.

Parameters:

  • ids (Array<String>) —

    The uuids of compliance rules to retrieve (maximum 350 IDs allowed).

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, supported properties: - &#x60;account_id&#x60; - &#x60;account_name&#x60; - &#x60;business_impact&#x60; - &#x60;cloud_label&#x60; - &#x60;cloud_label_id&#x60; - &#x60;cloud_provider&#x60; - &#x60;environment&#x60; - &#x60;groups&#x60; - &#x60;region&#x60; - &#x60;resource_type&#x60; - &#x60;resource_type_name&#x60; - &#x60;tag_key&#x60; - &#x60;tag_value&#x60; - &#x60;tags_string&#x60;

Returns:



112
113
114
115
 
# File 'lib/crimson-falcon/api/cloud_security_compliance.rb', line 112

def cloud_compliance_rule_posture_summaries(ids, opts = {})
  data, _status_code, _headers = cloud_compliance_rule_posture_summaries_with_http_info(ids, opts)
  data
end

#cloud_compliance_rule_posture_summaries_with_http_info(ids, opts = {}) ⇒ Array<(ComplianceRulePostureSummaryResponse, Integer, Hash)>

Get compliance score and counts for rules.

Parameters:

  • ids (Array<String>) —

    The uuids of compliance rules to retrieve (maximum 350 IDs allowed).

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, supported properties: - &#x60;account_id&#x60; - &#x60;account_name&#x60; - &#x60;business_impact&#x60; - &#x60;cloud_label&#x60; - &#x60;cloud_label_id&#x60; - &#x60;cloud_provider&#x60; - &#x60;environment&#x60; - &#x60;groups&#x60; - &#x60;region&#x60; - &#x60;resource_type&#x60; - &#x60;resource_type_name&#x60; - &#x60;tag_key&#x60; - &#x60;tag_value&#x60; - &#x60;tags_string&#x60;

Returns:



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

def cloud_compliance_rule_posture_summaries_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudSecurityCompliance.cloud_compliance_rule_posture_summaries ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CloudSecurityCompliance.cloud_compliance_rule_posture_summaries"
  end
  if @api_client.config.client_side_validation && ids.length > 350
    fail ArgumentError, 'invalid value for "ids" when calling CloudSecurityCompliance.cloud_compliance_rule_posture_summaries, number of items must be less than or equal to 350.'
  end

  # resource path
  local_var_path = '/cloud-security-compliance/entities/rule-posture-summaries/v1'

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

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

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