Class: OCI::OperatorAccessControl::AccessRequestsClient
- Inherits:
-
Object
- Object
- OCI::OperatorAccessControl::AccessRequestsClient
- Defined in:
- lib/oci/operator_access_control/access_requests_client.rb
Overview
Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure. Using logging service, you can view a near real-time audit report of all actions performed by an Oracle operator.
Use the table of contents and search tool to explore the OperatorAccessControl API.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#approve_access_request(access_request_id, approve_access_request_details, opts = {}) ⇒ Response
Approves an access request.
-
#get_access_request(access_request_id, opts = {}) ⇒ Response
Gets details of an access request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AccessRequestsClient
constructor
Creates a new AccessRequestsClient.
-
#interaction_request(access_request_id, interaction_request_details, opts = {}) ⇒ Response
Posts query for additional information for the given access request.
-
#list_access_request_histories(access_request_id, opts = {}) ⇒ Response
Returns a history of all status associated with the accessRequestId.
-
#list_access_requests(compartment_id, opts = {}) ⇒ Response
Lists all access requests in the compartment.
-
#list_interactions(access_request_id, opts = {}) ⇒ Response
Lists the MoreInformation interaction between customer and operators.
-
#logger ⇒ Logger
The logger for this client.
-
#reject_access_request(access_request_id, reject_access_request_details, opts = {}) ⇒ Response
Rejects an access request.
-
#review_access_request(access_request_id, review_access_request_details, opts = {}) ⇒ Response
Reviews the access request.
-
#revoke_access_request(access_request_id, revoke_access_request_details, opts = {}) ⇒ Response
Revokes an already approved access request.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AccessRequestsClient
Creates a new AccessRequestsClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 58 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20200630' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "AccessRequestsClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
18 19 20 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 18 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
22 23 24 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 22 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
32 33 34 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 32 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
28 29 30 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 28 def retry_config @retry_config end |
Instance Method Details
#approve_access_request(access_request_id, approve_access_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use approve_access_request API.
Approves an access request.
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 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 128 def approve_access_request(access_request_id, approve_access_request_details, opts = {}) logger.debug 'Calling operation AccessRequestsClient#approve_access_request.' if logger raise "Missing the required parameter 'access_request_id' when calling approve_access_request." if access_request_id.nil? raise "Missing the required parameter 'approve_access_request_details' when calling approve_access_request." if approve_access_request_details.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/action/approve'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(approve_access_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#approve_access_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_access_request(access_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_access_request API.
Gets details of an access request.
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 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 185 def get_access_request(access_request_id, opts = {}) logger.debug 'Calling operation AccessRequestsClient#get_access_request.' if logger raise "Missing the required parameter 'access_request_id' when calling get_access_request." if access_request_id.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#get_access_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::AccessRequest' ) end # rubocop:enable Metrics/BlockLength end |
#interaction_request(access_request_id, interaction_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use interaction_request API.
Posts query for additional information for the given access request.
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 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 253 def interaction_request(access_request_id, interaction_request_details, opts = {}) logger.debug 'Calling operation AccessRequestsClient#interaction_request.' if logger raise "Missing the required parameter 'access_request_id' when calling interaction_request." if access_request_id.nil? raise "Missing the required parameter 'interaction_request_details' when calling interaction_request." if interaction_request_details.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/action/interactionRequest'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(interaction_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#interaction_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::AccessRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_access_request_histories(access_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_access_request_histories API.
Returns a history of all status associated with the accessRequestId.
314 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 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 314 def list_access_request_histories(access_request_id, opts = {}) logger.debug 'Calling operation AccessRequestsClient#list_access_request_histories.' if logger raise "Missing the required parameter 'access_request_id' when calling list_access_request_histories." if access_request_id.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/history'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#list_access_request_histories') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::AccessRequestHistoryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_access_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_access_requests API.
Lists all access requests in the compartment.
Allowed values are: timeCreated, displayName
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 440 441 442 443 444 445 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 388 def list_access_requests(compartment_id, opts = {}) logger.debug 'Calling operation AccessRequestsClient#list_access_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_access_requests." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::OperatorAccessControl::Models::ACCESS_REQUEST_LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OperatorAccessControl::Models::ACCESS_REQUEST_LIFECYCLE_STATES_ENUM.' end if opts[:sort_order] && !OCI::OperatorAccessControl::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OperatorAccessControl::Models::SORT_ORDERS_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/accessRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:resourceName] = opts[:resource_name] if opts[:resource_name] query_params[:resourceType] = opts[:resource_type] if opts[:resource_type] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:timeStart] = opts[:time_start] if opts[:time_start] query_params[:timeEnd] = opts[:time_end] if opts[:time_end] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#list_access_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::AccessRequestCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_interactions(access_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_interactions API.
Lists the MoreInformation interaction between customer and operators.
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 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 466 def list_interactions(access_request_id, opts = {}) logger.debug 'Calling operation AccessRequestsClient#list_interactions.' if logger raise "Missing the required parameter 'access_request_id' when calling list_interactions." if access_request_id.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/interactions'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#list_interactions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::InteractionCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
97 98 99 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 97 def logger @api_client.config.logger end |
#reject_access_request(access_request_id, reject_access_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use reject_access_request API.
Rejects an access request.
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 573 574 575 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 536 def reject_access_request(access_request_id, reject_access_request_details, opts = {}) logger.debug 'Calling operation AccessRequestsClient#reject_access_request.' if logger raise "Missing the required parameter 'access_request_id' when calling reject_access_request." if access_request_id.nil? raise "Missing the required parameter 'reject_access_request_details' when calling reject_access_request." if reject_access_request_details.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/action/reject'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(reject_access_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#reject_access_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#review_access_request(access_request_id, review_access_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use review_access_request API.
Reviews the access request.
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 646 647 |
# File 'lib/oci/operator_access_control/access_requests_client.rb', line 607 def review_access_request(access_request_id, review_access_request_details, opts = {}) logger.debug 'Calling operation AccessRequestsClient#review_access_request.' if logger raise "Missing the required parameter 'access_request_id' when calling review_access_request." if access_request_id.nil? raise "Missing the required parameter 'review_access_request_details' when calling review_access_request." if review_access_request_details.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/action/review'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(review_access_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#review_access_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OperatorAccessControl::Models::AccessRequest' ) end # rubocop:enable Metrics/BlockLength end |
#revoke_access_request(access_request_id, revoke_access_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use revoke_access_request API.
Revokes an already approved access request.
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/oci/operator_access_control/access_requests_client.rb', line 679 def revoke_access_request(access_request_id, revoke_access_request_details, opts = {}) logger.debug 'Calling operation AccessRequestsClient#revoke_access_request.' if logger raise "Missing the required parameter 'access_request_id' when calling revoke_access_request." if access_request_id.nil? raise "Missing the required parameter 'revoke_access_request_details' when calling revoke_access_request." if revoke_access_request_details.nil? raise "Parameter value for 'access_request_id' must not be blank" if OCI::Internal::Util.blank_string?(access_request_id) path = '/accessRequests/{accessRequestId}/action/revoke'.sub('{accessRequestId}', access_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(revoke_access_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessRequestsClient#revoke_access_request') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |