Class: Falcon::CloudAwsRegistration

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudAwsRegistration

Returns a new instance of CloudAwsRegistration.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#cloud_registration_aws_create_account(body, opts = {}) ⇒ RestAWSAccountCreateResponseExtV1

Creates a new account in our system for a customer.

Parameters:

Returns:



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

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

#cloud_registration_aws_create_account_with_http_info(body, opts = {}) ⇒ Array<(RestAWSAccountCreateResponseExtV1, Integer, Hash)>

Creates a new account in our system for a customer.

Parameters:

Returns:



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

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAwsRegistration.cloud_registration_aws_create_account ...'
  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 CloudAwsRegistration.cloud_registration_aws_create_account"
  end
  # resource path
  local_var_path = '/cloud-security-registration-aws/entities/account/v1'

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

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

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

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

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

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

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

#cloud_registration_aws_delete_account(opts = {}) ⇒ MsaspecResponseFields

Deletes an existing AWS account or organization in our system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS account IDs to remove

  • :organization_ids (Array<String>) —

    AWS organization IDs to remove

Returns:



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

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

#cloud_registration_aws_delete_account_with_http_info(opts = {}) ⇒ Array<(MsaspecResponseFields, Integer, Hash)>

Deletes an existing AWS account or organization in our system.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS account IDs to remove

  • :organization_ids (Array<String>) —

    AWS organization IDs to remove

Returns:

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

    MsaspecResponseFields data, response status code and response headers



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

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAwsRegistration.cloud_registration_aws_delete_account ...'
  end
  # resource path
  local_var_path = '/cloud-security-registration-aws/entities/account/v1'

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

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

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

#cloud_registration_aws_get_accounts(opts = {}) ⇒ RestAWSAccountCreateResponseExtV1

Retrieve existing AWS accounts by account IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS account IDs to filter

Returns:



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

def cloud_registration_aws_get_accounts(opts = {})
  data, _status_code, _headers = cloud_registration_aws_get_accounts_with_http_info(opts)
  data
end

#cloud_registration_aws_get_accounts_with_http_info(opts = {}) ⇒ Array<(RestAWSAccountCreateResponseExtV1, Integer, Hash)>

Retrieve existing AWS accounts by account IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS account IDs to filter

Returns:



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

def cloud_registration_aws_get_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAwsRegistration.cloud_registration_aws_get_accounts ...'
  end
  # resource path
  local_var_path = '/cloud-security-registration-aws/entities/account/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] || 'RestAWSAccountCreateResponseExtV1'

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

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

#cloud_registration_aws_query_accounts(products, features, opts = {}) ⇒ RestAWSAccountCreateResponseExtV1

Retrieve existing AWS accounts by account IDs

Parameters:

  • products (Array<String>) —

    Products registered for an account

  • features (Array<String>) —

    Features registered for an account

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

    the optional parameters

Options Hash (opts):

  • :organization_ids (Array<String>) —

    Organization IDs used to filter accounts

  • :account_status (String) —

    Account status to filter results by.

  • :limit (Integer) —

    The maximum number of items to return. When not specified or 0, 100 is used. When larger than 500, 500 is used. (default to 100)

  • :offset (Integer) —

    The offset to start retrieving records from.

  • :group_by (String) —

    Field to group by.

Returns:



234
235
236
237
 
# File 'lib/crimson-falcon/api/cloud_aws_registration.rb', line 234

def cloud_registration_aws_query_accounts(products, features, opts = {})
  data, _status_code, _headers = cloud_registration_aws_query_accounts_with_http_info(products, features, opts)
  data
end

#cloud_registration_aws_query_accounts_with_http_info(products, features, opts = {}) ⇒ Array<(RestAWSAccountCreateResponseExtV1, Integer, Hash)>

Retrieve existing AWS accounts by account IDs

Parameters:

  • products (Array<String>) —

    Products registered for an account

  • features (Array<String>) —

    Features registered for an account

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

    the optional parameters

Options Hash (opts):

  • :organization_ids (Array<String>) —

    Organization IDs used to filter accounts

  • :account_status (String) —

    Account status to filter results by.

  • :limit (Integer) —

    The maximum number of items to return. When not specified or 0, 100 is used. When larger than 500, 500 is used. (default to 100)

  • :offset (Integer) —

    The offset to start retrieving records from.

  • :group_by (String) —

    Field to group by.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/crimson-falcon/api/cloud_aws_registration.rb', line 249

def cloud_registration_aws_query_accounts_with_http_info(products, features, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAwsRegistration.cloud_registration_aws_query_accounts ...'
  end
  # verify the required parameter 'products' is set
  if @api_client.config.client_side_validation && products.nil?
    fail ArgumentError, "Missing the required parameter 'products' when calling CloudAwsRegistration.cloud_registration_aws_query_accounts"
  end
  # verify the required parameter 'features' is set
  if @api_client.config.client_side_validation && features.nil?
    fail ArgumentError, "Missing the required parameter 'features' when calling CloudAwsRegistration.cloud_registration_aws_query_accounts"
  end
  allowable_values = ["provisioned", "operational"]
  if @api_client.config.client_side_validation && opts[:'account_status'] && !allowable_values.include?(opts[:'account_status'])
    fail ArgumentError, "invalid value for \"account_status\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CloudAwsRegistration.cloud_registration_aws_query_accounts, must be smaller than or equal to 500.'
  end

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

  allowable_values = ["organization"]
  if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
    fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/cloud-security-registration-aws/queries/account/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'products'] = @api_client.build_collection_param(products, :multi)
  query_params[:'features'] = @api_client.build_collection_param(features, :multi)
  query_params[:'organization-ids'] = @api_client.build_collection_param(opts[:'organization_ids'], :multi) if !opts[:'organization_ids'].nil?
  query_params[:'account-status'] = opts[:'account_status'] if !opts[:'account_status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].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] || 'RestAWSAccountCreateResponseExtV1'

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

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

#cloud_registration_aws_update_account(body, opts = {}) ⇒ RestAWSAccountCreateResponseExtV1

Patches a existing account in our system for a customer.

Parameters:

Returns:



328
329
330
331
 
# File 'lib/crimson-falcon/api/cloud_aws_registration.rb', line 328

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

#cloud_registration_aws_update_account_with_http_info(body, opts = {}) ⇒ Array<(RestAWSAccountCreateResponseExtV1, Integer, Hash)>

Patches a existing account in our system for a customer.

Parameters:

Returns:



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/crimson-falcon/api/cloud_aws_registration.rb', line 337

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudAwsRegistration.cloud_registration_aws_update_account ...'
  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 CloudAwsRegistration.cloud_registration_aws_update_account"
  end
  # resource path
  local_var_path = '/cloud-security-registration-aws/entities/account/v1'

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

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

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

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

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

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

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