Class: Falcon::AdmissionControlPolicies

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdmissionControlPolicies

Returns a new instance of AdmissionControlPolicies.



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

def api_client
  @api_client
end

Instance Method Details

#admission_control_add_host_groups(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Add one or more host groups to an admission control policy.

Parameters:

Returns:



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

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

#admission_control_add_host_groups_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Add one or more host groups to an admission control policy.

Parameters:

Returns:



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

def admission_control_add_host_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_add_host_groups ...'
  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 AdmissionControlPolicies.admission_control_add_host_groups"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-host-groups/v1'

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

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

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

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

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

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

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

#admission_control_add_rule_group_custom_rule(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Add one or more custom Rego rules to a rule group in an admission control policy. The requested custom rules are also added to all other unspecified rule groups in the policy with action ‘Disabled’.

Parameters:

Returns:



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

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

#admission_control_add_rule_group_custom_rule_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Add one or more custom Rego rules to a rule group in an admission control policy. The requested custom rules are also added to all other unspecified rule groups in the policy with action &#39;Disabled&#39;.

Parameters:

Returns:



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

def admission_control_add_rule_group_custom_rule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_add_rule_group_custom_rule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AdmissionControlPolicies.admission_control_add_rule_group_custom_rule"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-group-custom-rules/v1'

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

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

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

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

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

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

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

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

#admission_control_create_policy(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Create an admission control policy.

Parameters:

Returns:



174
175
176
177
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 174

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

#admission_control_create_policy_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Create an admission control policy.

Parameters:

Returns:



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
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 183

def admission_control_create_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_create_policy ...'
  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 AdmissionControlPolicies.admission_control_create_policy"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policies/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] || 'ModelsKACPolicyEntitiesResponse'

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

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

#admission_control_create_rule_groups(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Create one or more rule groups and add them to an existing admission control policy. The list of new rule groups will be created with the last rule group having highest precedence, second to last with second highest precedence, and so on.

Parameters:

Returns:



240
241
242
243
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 240

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

#admission_control_create_rule_groups_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Create one or more rule groups and add them to an existing admission control policy. The list of new rule groups will be created with the last rule group having highest precedence, second to last with second highest precedence, and so on.

Parameters:

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

def admission_control_create_rule_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_create_rule_groups ...'
  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 AdmissionControlPolicies.admission_control_create_rule_groups"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-groups/v1'

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

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

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

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

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

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

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

#admission_control_delete_policies(ids, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Delete an admission control policy.

Parameters:

  • ids (Array<String>) —

    The ids of the policies to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



306
307
308
309
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 306

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

#admission_control_delete_policies_with_http_info(ids, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Delete an admission control policy.

Parameters:

  • ids (Array<String>) —

    The ids of the policies to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



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
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 315

def admission_control_delete_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_delete_policies ...'
  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 AdmissionControlPolicies.admission_control_delete_policies"
  end
  if @api_client.config.client_side_validation && ids.length > 100
    fail ArgumentError, 'invalid value for "ids" when calling AdmissionControlPolicies.admission_control_delete_policies, number of items must be less than or equal to 100.'
  end

  # resource path
  local_var_path = '/admission-control-policies/entities/policies/v1'

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

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

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

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

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

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

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

#admission_control_delete_rule_groups(policy_id, rule_group_ids, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Delete rule groups.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • rule_group_ids (Array<String>) —

    The ids of the rule groups to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



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

def admission_control_delete_rule_groups(policy_id, rule_group_ids, opts = {})
  data, _status_code, _headers = admission_control_delete_rule_groups_with_http_info(policy_id, rule_group_ids, opts)
  data
end

#admission_control_delete_rule_groups_with_http_info(policy_id, rule_group_ids, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Delete rule groups.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • rule_group_ids (Array<String>) —

    The ids of the rule groups to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



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

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

  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'policy_id'] = policy_id
  query_params[:'rule_group_ids'] = @api_client.build_collection_param(rule_group_ids, :multi)

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

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

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

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

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

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

#admission_control_get_policies(ids, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Get admission control policies.

Parameters:

  • ids (Array<String>) —

    The list of policies to return (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



445
446
447
448
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 445

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

#admission_control_get_policies_with_http_info(ids, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Get admission control policies.

Parameters:

  • ids (Array<String>) —

    The list of policies to return (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 454

def admission_control_get_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_get_policies ...'
  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 AdmissionControlPolicies.admission_control_get_policies"
  end
  if @api_client.config.client_side_validation && ids.length > 100
    fail ArgumentError, 'invalid value for "ids" when calling AdmissionControlPolicies.admission_control_get_policies, number of items must be less than or equal to 100.'
  end

  # resource path
  local_var_path = '/admission-control-policies/entities/policies/v1'

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

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

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

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

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

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

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

#admission_control_query_policies(opts = {}) ⇒ MsaspecQueryResponse

Search admission control policies.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: - &#x60;precedence&#x60; - &#x60;created_timestamp&#x60; - &#x60;modified_timestamp&#x60; - &#x60;name&#x60; - &#x60;description&#x60;

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: - &#x60;precedence&#x60; - &#x60;created_timestamp&#x60; - &#x60;modified_timestamp&#x60; Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:



514
515
516
517
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 514

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

#admission_control_query_policies_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Search admission control policies.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter, allowed properties: - &#x60;precedence&#x60; - &#x60;created_timestamp&#x60; - &#x60;modified_timestamp&#x60; - &#x60;name&#x60; - &#x60;description&#x60;

  • :limit (Integer) —

    The maximum number of resources to return. The maximum allowed is 500. (default to 100)

  • :offset (Integer) —

    The number of results to skip before starting to return results. (default to 0)

  • :sort (String) —

    Field to sort on. Sortable fields: - &#x60;precedence&#x60; - &#x60;created_timestamp&#x60; - &#x60;modified_timestamp&#x60; Use the &#x60;|asc&#x60; or &#x60;|desc&#x60; suffix to specify sort direction.

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 526

def admission_control_query_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_query_policies ...'
  end
  # resource path
  local_var_path = '/admission-control-policies/queries/policies/v1'

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

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

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

#admission_control_remove_host_groups(policy_id, host_group_ids, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Remove one or more host groups from an admission control policy.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • host_group_ids (Array<String>) —

    The ids of the host groups to remove (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



579
580
581
582
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 579

def admission_control_remove_host_groups(policy_id, host_group_ids, opts = {})
  data, _status_code, _headers = admission_control_remove_host_groups_with_http_info(policy_id, host_group_ids, opts)
  data
end

#admission_control_remove_host_groups_with_http_info(policy_id, host_group_ids, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Remove one or more host groups from an admission control policy.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • host_group_ids (Array<String>) —

    The ids of the host groups to remove (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 589

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

  # resource path
  local_var_path = '/admission-control-policies/entities/policy-host-groups/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'policy_id'] = policy_id
  query_params[:'host_group_ids'] = @api_client.build_collection_param(host_group_ids, :multi)

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

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

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

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

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

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

#admission_control_remove_rule_group_custom_rule(policy_id, custom_rule_ids, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Delete one or more custom Rego rules from all rule groups in an admission control policy.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • custom_rule_ids (Array<String>) —

    The ids of the custom Rego rules to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



652
653
654
655
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 652

def admission_control_remove_rule_group_custom_rule(policy_id, custom_rule_ids, opts = {})
  data, _status_code, _headers = admission_control_remove_rule_group_custom_rule_with_http_info(policy_id, custom_rule_ids, opts)
  data
end

#admission_control_remove_rule_group_custom_rule_with_http_info(policy_id, custom_rule_ids, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Delete one or more custom Rego rules from all rule groups in an admission control policy.

Parameters:

  • policy_id (String) —

    The id of the policy to modify.

  • custom_rule_ids (Array<String>) —

    The ids of the custom Rego rules to delete (maximum 100 IDs allowed).

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

    the optional parameters

Returns:



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 662

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

  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-group-custom-rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'policy_id'] = policy_id
  query_params[:'custom_rule_ids'] = @api_client.build_collection_param(custom_rule_ids, :multi)

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

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

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

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

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

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

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

#admission_control_replace_rule_group_selectors(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Replace labels and/or namespaces of a rule group within an admission control policy.

Parameters:

Returns:



724
725
726
727
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 724

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

#admission_control_replace_rule_group_selectors_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Replace labels and/or namespaces of a rule group within an admission control policy.

Parameters:

Returns:



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 733

def admission_control_replace_rule_group_selectors_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_replace_rule_group_selectors ...'
  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 AdmissionControlPolicies.admission_control_replace_rule_group_selectors"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-group-selectors/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] || 'ModelsKACPolicyEntitiesResponse'

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

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

#admission_control_set_rule_group_precedence(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Change precedence of rule groups within an admission control policy.

Parameters:

Returns:



790
791
792
793
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 790

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

#admission_control_set_rule_group_precedence_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Change precedence of rule groups within an admission control policy.

Parameters:

Returns:



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
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 799

def admission_control_set_rule_group_precedence_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_set_rule_group_precedence ...'
  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 AdmissionControlPolicies.admission_control_set_rule_group_precedence"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-group-precedence/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] || 'ModelsKACPolicyEntitiesResponse'

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

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

#admission_control_update_policy(ids, body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Update an admission control policy.

Parameters:

  • ids (String) —

    The id of the admission control policy to update.

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

    the optional parameters

Returns:



857
858
859
860
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 857

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

#admission_control_update_policy_precedence(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Update admission control policy precedence.

Parameters:

Returns:



929
930
931
932
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 929

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

#admission_control_update_policy_precedence_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Update admission control policy precedence.

Parameters:

Returns:



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
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 938

def admission_control_update_policy_precedence_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_update_policy_precedence ...'
  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 AdmissionControlPolicies.admission_control_update_policy_precedence"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-precedence/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] || 'ModelsKACPolicyEntitiesResponse'

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

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

#admission_control_update_policy_with_http_info(ids, body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Update an admission control policy.

Parameters:

  • ids (String) —

    The id of the admission control policy to update.

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

    the optional parameters

Returns:



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
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 867

def admission_control_update_policy_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_update_policy ...'
  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 AdmissionControlPolicies.admission_control_update_policy"
  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 AdmissionControlPolicies.admission_control_update_policy"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policies/v1'

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

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

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

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

#admission_control_update_rule_groups(body, opts = {}) ⇒ ModelsKACPolicyEntitiesResponse

Update a rule group. Change rule group name, description, deny on error, Image Assessment settings, default rule actions, and custom rule actions.

Parameters:

  • body (ModelsUpdatePolicyRuleGroupRequest) —

    Valid rule action values: - Disabled - Prevent - Alert Valid image assessment unassessed handling values: - Prevent - Alert - Allow Without Alert Default rule codes: - 201000: Privileged container(s) - 201001: Sensitive data in environment - 201002: Sensitive data in secretKeyRef - 201004: Container(s) run as root - 201005: Container(s) without runAsNonRoot - 201006: Privilege escalation allowed - 201007: Container(s) with network capabilities - 201008: Container(s) with unsafe procMount - 201009: Container(s) using unsafe sysctls - 201010: Container(s) without resource limits - 201011: Sensitive host directories mounted in container(s) - 201012: Container(s) with sysadmin capability - 201013: Service attached to load balancer - 201014: Service attached to node port - 201015: Host port attached to container(s) - 201016: Host network attached to container(s) - 201017: Container(s) in host PID namespace - 201018: Container(s) in host IPC namespace - 201019: Workload in default namespace - 201020: Workload with unconfined seccomp profile - 201021: Workload without SELinux or AppArmor - 201022: Container(s) with many capabilities - 201023: Workload without recommended seccomp profile - 201024: Workload without securityContext - 201025: Container runtime socket in container(s) - 201026: Container(s) entrypoint contains network scanning command - 201027: Container(s) entrypoint contains chroot command - 201028: Malformed sysctl value - 201029: Service account token automounted

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

    the optional parameters

Returns:



995
996
997
998
 
# File 'lib/crimson-falcon/api/admission_control_policies.rb', line 995

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

#admission_control_update_rule_groups_with_http_info(body, opts = {}) ⇒ Array<(ModelsKACPolicyEntitiesResponse, Integer, Hash)>

Update a rule group. Change rule group name, description, deny on error, Image Assessment settings, default rule actions, and custom rule actions.

Parameters:

  • body (ModelsUpdatePolicyRuleGroupRequest) —

    Valid rule action values: - Disabled - Prevent - Alert Valid image assessment unassessed handling values: - Prevent - Alert - Allow Without Alert Default rule codes: - 201000: Privileged container(s) - 201001: Sensitive data in environment - 201002: Sensitive data in secretKeyRef - 201004: Container(s) run as root - 201005: Container(s) without runAsNonRoot - 201006: Privilege escalation allowed - 201007: Container(s) with network capabilities - 201008: Container(s) with unsafe procMount - 201009: Container(s) using unsafe sysctls - 201010: Container(s) without resource limits - 201011: Sensitive host directories mounted in container(s) - 201012: Container(s) with sysadmin capability - 201013: Service attached to load balancer - 201014: Service attached to node port - 201015: Host port attached to container(s) - 201016: Host network attached to container(s) - 201017: Container(s) in host PID namespace - 201018: Container(s) in host IPC namespace - 201019: Workload in default namespace - 201020: Workload with unconfined seccomp profile - 201021: Workload without SELinux or AppArmor - 201022: Container(s) with many capabilities - 201023: Workload without recommended seccomp profile - 201024: Workload without securityContext - 201025: Container runtime socket in container(s) - 201026: Container(s) entrypoint contains network scanning command - 201027: Container(s) entrypoint contains chroot command - 201028: Malformed sysctl value - 201029: Service account token automounted

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

    the optional parameters

Returns:



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

def admission_control_update_rule_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdmissionControlPolicies.admission_control_update_rule_groups ...'
  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 AdmissionControlPolicies.admission_control_update_rule_groups"
  end
  # resource path
  local_var_path = '/admission-control-policies/entities/policy-rule-groups/v1'

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

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

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

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

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

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

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