Class: SwaggerClient::PolicyOverrideApi
- Inherits:
-
Object
- Object
- SwaggerClient::PolicyOverrideApi
- Defined in:
- lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_policy_override(opts = {}) ⇒ CreatedReferencePolicyOverrideIDLink
Policy Overrides Submit a policy override.
-
#create_policy_override_with_http_info(opts = {}) ⇒ Array<(CreatedReferencePolicyOverrideIDLink, Integer, Hash)>
Policy Overrides Submit a policy override.
-
#delete_policy_override(id, opts = {}) ⇒ Links
Policy Override Removes a policy override created for a policy rule.
-
#delete_policy_override_with_http_info(id, opts = {}) ⇒ Array<(Links, Integer, Hash)>
Policy Override Removes a policy override created for a policy rule.
-
#get_asset_policy_overrides(id, opts = {}) ⇒ ResourcesPolicyOverride
Asset Policy Overrides Retrieves policy overrides defined on policy rules for the specified asset.
-
#get_asset_policy_overrides_with_http_info(id, opts = {}) ⇒ Array<(ResourcesPolicyOverride, Integer, Hash)>
Asset Policy Overrides Retrieves policy overrides defined on policy rules for the specified asset.
-
#get_policy_override(id, opts = {}) ⇒ PolicyOverride
Policy Override Retrieve the specified policy override.
-
#get_policy_override_expiration(id, opts = {}) ⇒ String
Policy Override Expiration Get the expiration date for a policy override.
-
#get_policy_override_expiration_with_http_info(id, opts = {}) ⇒ Array<(String, Integer, Hash)>
Policy Override Expiration Get the expiration date for a policy override.
-
#get_policy_override_with_http_info(id, opts = {}) ⇒ Array<(PolicyOverride, Integer, Hash)>
Policy Override Retrieve the specified policy override.
-
#get_policy_overrides(opts = {}) ⇒ PageOfPolicyOverride
Policy Overrides Retrieves policy overrides defined on policy rules.
-
#get_policy_overrides_with_http_info(opts = {}) ⇒ Array<(PageOfPolicyOverride, Integer, Hash)>
Policy Overrides Retrieves policy overrides defined on policy rules.
-
#initialize(api_client = ApiClient.default) ⇒ PolicyOverrideApi
constructor
A new instance of PolicyOverrideApi.
-
#set_policy_override_expiration(id, opts = {}) ⇒ Links
Policy Override Expiration Set the expiration date for a policy override.
-
#set_policy_override_expiration_with_http_info(id, opts = {}) ⇒ Array<(Links, Integer, Hash)>
Policy Override Expiration Set the expiration date for a policy override.
-
#set_policy_override_status(id, status, opts = {}) ⇒ nil
Policy Override Status Update the status of the specified policy override.
-
#set_policy_override_status_with_http_info(id, status, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Policy Override Status Update the status of the specified policy override.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PolicyOverrideApi
Returns a new instance of PolicyOverrideApi.
16 17 18 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
14 15 16 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#create_policy_override(opts = {}) ⇒ CreatedReferencePolicyOverrideIDLink
Policy Overrides Submit a policy override. The policy override can be submitted or it can be submitted and approved in a single request.
24 25 26 27 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 24 def create_policy_override(opts = {}) data, _status_code, _headers = create_policy_override_with_http_info(opts) data end |
#create_policy_override_with_http_info(opts = {}) ⇒ Array<(CreatedReferencePolicyOverrideIDLink, Integer, Hash)>
Policy Overrides Submit a policy override. The policy override can be submitted or it can be submitted and approved in a single request.
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 34 def create_policy_override_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.create_policy_override ...' end # resource path local_var_path = '/api/3/policy_overrides' # 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;charset=UTF-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) return_type = opts[:return_type] || 'CreatedReferencePolicyOverrideIDLink' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#create_policy_override\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_policy_override(id, opts = {}) ⇒ Links
Policy Override Removes a policy override created for a policy rule.
78 79 80 81 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 78 def delete_policy_override(id, opts = {}) data, _status_code, _headers = delete_policy_override_with_http_info(site_idte_id, opts) data end |
#delete_policy_override_with_http_info(id, opts = {}) ⇒ Array<(Links, Integer, Hash)>
Policy Override Removes a policy override created for a policy rule.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 88 def delete_policy_override_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.delete_policy_override ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.delete_policy_override" end # resource path local_var_path = '/api/3/policy_overrides/{id}'.sub('{' + 'id' + '}', site_idte_id.to_s) # 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;charset=UTF-8']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'Links' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#delete_policy_override\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_asset_policy_overrides(id, opts = {}) ⇒ ResourcesPolicyOverride
Asset Policy Overrides Retrieves policy overrides defined on policy rules for the specified asset.
134 135 136 137 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 134 def get_asset_policy_overrides(id, opts = {}) data, _status_code, _headers = get_asset_policy_overrides_with_http_info(site_idte_id, opts) data end |
#get_asset_policy_overrides_with_http_info(id, opts = {}) ⇒ Array<(ResourcesPolicyOverride, Integer, Hash)>
Asset Policy Overrides Retrieves policy overrides defined on policy rules for the specified asset.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 144 def get_asset_policy_overrides_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.get_asset_policy_overrides ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.get_asset_policy_overrides" end # resource path local_var_path = '/api/3/assets/{id}/policy_overrides'.sub('{' + 'id' + '}', site_idte_id.to_s) # 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;charset=UTF-8']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'ResourcesPolicyOverride' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#get_asset_policy_overrides\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_policy_override(id, opts = {}) ⇒ PolicyOverride
Policy Override Retrieve the specified policy override.
190 191 192 193 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 190 def get_policy_override(id, opts = {}) data, _status_code, _headers = get_policy_override_with_http_info(site_idte_id, opts) data end |
#get_policy_override_expiration(id, opts = {}) ⇒ String
Policy Override Expiration Get the expiration date for a policy override.
246 247 248 249 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 246 def get_policy_override_expiration(id, opts = {}) data, _status_code, _headers = get_policy_override_expiration_with_http_info(site_idte_id, opts) data end |
#get_policy_override_expiration_with_http_info(id, opts = {}) ⇒ Array<(String, Integer, Hash)>
Policy Override Expiration Get the expiration date for a policy override.
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 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 256 def get_policy_override_expiration_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.get_policy_override_expiration ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.get_policy_override_expiration" end # resource path local_var_path = '/api/3/policy_overrides/{id}/expires'.sub('{' + 'id' + '}', site_idte_id.to_s) # 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;charset=UTF-8']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'String' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#get_policy_override_expiration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_policy_override_with_http_info(id, opts = {}) ⇒ Array<(PolicyOverride, Integer, Hash)>
Policy Override Retrieve the specified policy override.
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 235 236 237 238 239 240 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 200 def get_policy_override_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.get_policy_override ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.get_policy_override" end # resource path local_var_path = '/api/3/policy_overrides/{id}'.sub('{' + 'id' + '}', site_idte_id.to_s) # 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;charset=UTF-8']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'PolicyOverride' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#get_policy_override\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_policy_overrides(opts = {}) ⇒ PageOfPolicyOverride
Policy Overrides Retrieves policy overrides defined on policy rules.
304 305 306 307 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 304 def get_policy_overrides(opts = {}) data, _status_code, _headers = get_policy_overrides_with_http_info(opts) data end |
#get_policy_overrides_with_http_info(opts = {}) ⇒ Array<(PageOfPolicyOverride, Integer, Hash)>
Policy Overrides Retrieves policy overrides defined on policy rules.
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 316 def get_policy_overrides_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.get_policy_overrides ...' end # resource path local_var_path = '/api/3/policy_overrides' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) 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;charset=UTF-8']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'PageOfPolicyOverride' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#get_policy_overrides\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#set_policy_override_expiration(id, opts = {}) ⇒ Links
Policy Override Expiration Set the expiration date for a policy override. This must be a valid date in the future.
362 363 364 365 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 362 def set_policy_override_expiration(id, opts = {}) data, _status_code, _headers = set_policy_override_expiration_with_http_info(site_idte_id, opts) data end |
#set_policy_override_expiration_with_http_info(id, opts = {}) ⇒ Array<(Links, Integer, Hash)>
Policy Override Expiration Set the expiration date for a policy override. This must be a valid date in the future.
373 374 375 376 377 378 379 380 381 382 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 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 373 def set_policy_override_expiration_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.set_policy_override_expiration ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.set_policy_override_expiration" end # resource path local_var_path = '/api/3/policy_overrides/{id}/expires'.sub('{' + 'id' + '}', site_idte_id.to_s) # 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;charset=UTF-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) return_type = opts[:return_type] || 'Links' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#set_policy_override_expiration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#set_policy_override_status(id, status, opts = {}) ⇒ nil
Policy Override Status Update the status of the specified policy override. The status can be one of the following: ‘"recall"`, `"approve"`, or `"reject"`.
423 424 425 426 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 423 def set_policy_override_status(id, status, opts = {}) set_policy_override_status_with_http_info(site_idte_id, status, opts) nil end |
#set_policy_override_status_with_http_info(id, status, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Policy Override Status Update the status of the specified policy override. The status can be one of the following: `"recall"`, `"approve"`, or `"reject"`.
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 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 |
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/policy_override_api.rb', line 435 def set_policy_override_status_with_http_info(id, status, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PolicyOverrideApi.set_policy_override_status ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && site_idte_id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling PolicyOverrideApi.set_policy_override_status" end # verify the required parameter 'status' is set if @api_client.config.client_side_validation && status.nil? fail ArgumentError, "Missing the required parameter 'status' when calling PolicyOverrideApi.set_policy_override_status" end # verify enum value if @api_client.config.client_side_validation && !['recall', 'approve', 'reject'].include?(status) fail ArgumentError, "invalid value for 'status', must be one of recall, approve, reject" end # resource path local_var_path = '/api/3/policy_overrides/{id}/{status}'.sub('{' + 'id' + '}', site_idte_id.to_s).sub('{' + 'status' + '}', status.to_s) # 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;charset=UTF-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) return_type = opts[:return_type] auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: PolicyOverrideApi#set_policy_override_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |