Class: OCI::KeyManagement::KmsManagementClient
- Inherits:
-
Object
- Object
- OCI::KeyManagement::KmsManagementClient
- Defined in:
- lib/oci/key_management/kms_management_client.rb
Overview
API for managing and performing operations with keys and vaults.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#cancel_key_deletion(key_id, opts = {}) ⇒ Response
Cancels the scheduled deletion of the specified key.
-
#change_key_compartment(key_id, change_key_compartment_details, opts = {}) ⇒ Response
Moves a key into a different compartment.
-
#create_key(create_key_details, opts = {}) ⇒ Response
Creates a new key.
-
#create_key_version(key_id, opts = {}) ⇒ Response
Generates new cryptographic material for a key.
-
#disable_key(key_id, opts = {}) ⇒ Response
Disables a key to make it unavailable for encryption or decryption.
-
#enable_key(key_id, opts = {}) ⇒ Response
Enables a key to make it available for encryption or decryption.
-
#get_key(key_id, opts = {}) ⇒ Response
Gets information about the specified key.
-
#get_key_version(key_id, key_version_id, opts = {}) ⇒ Response
Gets information about the specified key version.
-
#initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ KmsManagementClient
constructor
Creates a new KmsManagementClient.
-
#list_key_versions(key_id, opts = {}) ⇒ Response
Lists all key versions for the specified key.
-
#list_keys(compartment_id, opts = {}) ⇒ Response
Lists the keys in the specified vault and compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#schedule_key_deletion(key_id, schedule_key_deletion_details, opts = {}) ⇒ Response
Schedules the deletion of the specified key.
-
#update_key(key_id, update_key_details, opts = {}) ⇒ Response
Updates the properties of a key.
Constructor Details
#initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ KmsManagementClient
Creates a new KmsManagementClient. Notes:
If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
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/oci/key_management/kms_management_client.rb', line 42 def initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) raise 'A fully qualified endpoint URL must be defined' unless endpoint @endpoint = endpoint + '/' # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config logger.info "KmsManagementClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
12 13 14 |
# File 'lib/oci/key_management/kms_management_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/key_management/kms_management_client.rb', line 16 def endpoint @endpoint 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
22 23 24 |
# File 'lib/oci/key_management/kms_management_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#cancel_key_deletion(key_id, opts = {}) ⇒ Response
Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key to the respective states they were in before the deletion was scheduled.
111 112 113 114 115 116 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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 111 def cancel_key_deletion(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#cancel_key_deletion.' if logger raise "Missing the required parameter 'key_id' when calling cancel_key_deletion." if key_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/actions/cancelDeletion'.sub('{keyId}', key_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[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#cancel_key_deletion') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#change_key_compartment(key_id, change_key_compartment_details, opts = {}) ⇒ Response
Moves a key into a different compartment. When provided, If-Match is checked against ETag values of the key.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 184 def change_key_compartment(key_id, change_key_compartment_details, opts = {}) logger.debug 'Calling operation KmsManagementClient#change_key_compartment.' if logger raise "Missing the required parameter 'key_id' when calling change_key_compartment." if key_id.nil? raise "Missing the required parameter 'change_key_compartment_details' when calling change_key_compartment." if change_key_compartment_details.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/actions/changeCompartment'.sub('{keyId}', key_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[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_key_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#change_key_compartment') 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 |
#create_key(create_key_details, opts = {}) ⇒ Response
Creates a new key.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 250 def create_key(create_key_details, opts = {}) logger.debug 'Calling operation KmsManagementClient#create_key.' if logger raise "Missing the required parameter 'create_key_details' when calling create_key." if create_key_details.nil? path = '/20180608/keys' 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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#create_key') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#create_key_version(key_id, opts = {}) ⇒ Response
Generates new cryptographic material for a key. The key must be in an ‘ENABLED` state to be rotated.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 316 def create_key_version(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#create_key_version.' if logger raise "Missing the required parameter 'key_id' when calling create_key_version." if key_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/keyVersions'.sub('{keyId}', key_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#create_key_version') 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::KeyManagement::Models::KeyVersion' ) end # rubocop:enable Metrics/BlockLength end |
#disable_key(key_id, opts = {}) ⇒ Response
Disables a key to make it unavailable for encryption or decryption.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 389 def disable_key(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#disable_key.' if logger raise "Missing the required parameter 'key_id' when calling disable_key." if key_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/actions/disable'.sub('{keyId}', key_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[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#disable_key') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#enable_key(key_id, opts = {}) ⇒ Response
Enables a key to make it available for encryption or decryption.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 463 def enable_key(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#enable_key.' if logger raise "Missing the required parameter 'key_id' when calling enable_key." if key_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/actions/enable'.sub('{keyId}', key_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[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#enable_key') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#get_key(key_id, opts = {}) ⇒ Response
Gets information about the specified key.
523 524 525 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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 523 def get_key(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#get_key.' if logger raise "Missing the required parameter 'key_id' when calling get_key." if key_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}'.sub('{keyId}', key_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: 'KmsManagementClient#get_key') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#get_key_version(key_id, key_version_id, opts = {}) ⇒ Response
Gets information about the specified key version.
581 582 583 584 585 586 587 588 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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 581 def get_key_version(key_id, key_version_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#get_key_version.' if logger raise "Missing the required parameter 'key_id' when calling get_key_version." if key_id.nil? raise "Missing the required parameter 'key_version_id' when calling get_key_version." if key_version_id.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) raise "Parameter value for 'key_version_id' must not be blank" if OCI::Internal::Util.blank_string?(key_version_id) path = '/20180608/keys/{keyId}/keyVersions/{keyVersionId}'.sub('{keyId}', key_id.to_s).sub('{keyVersionId}', key_version_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: 'KmsManagementClient#get_key_version') 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::KeyManagement::Models::KeyVersion' ) end # rubocop:enable Metrics/BlockLength end |
#list_key_versions(key_id, opts = {}) ⇒ Response
Lists all key versions for the specified key.
653 654 655 656 657 658 659 660 661 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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 653 def list_key_versions(key_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#list_key_versions.' if logger raise "Missing the required parameter 'key_id' when calling list_key_versions." if key_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/keyVersions'.sub('{keyId}', key_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] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # 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: 'KmsManagementClient#list_key_versions') 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: 'Array<OCI::KeyManagement::Models::KeyVersionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_keys(compartment_id, opts = {}) ⇒ Response
Lists the keys in the specified vault and compartment.
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 |
# File 'lib/oci/key_management/kms_management_client.rb', line 735 def list_keys(compartment_id, opts = {}) logger.debug 'Calling operation KmsManagementClient#list_keys.' if logger raise "Missing the required parameter 'compartment_id' when calling list_keys." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/20180608/keys' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # 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: 'KmsManagementClient#list_keys') 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: 'Array<OCI::KeyManagement::Models::KeySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
76 77 78 |
# File 'lib/oci/key_management/kms_management_client.rb', line 76 def logger @api_client.config.logger end |
#schedule_key_deletion(key_id, schedule_key_deletion_details, opts = {}) ⇒ Response
Schedules the deletion of the specified key. This sets the state of the key to ‘PENDING_DELETION` and then deletes it after the retention period ends.
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 851 852 853 854 855 856 857 858 859 |
# File 'lib/oci/key_management/kms_management_client.rb', line 819 def schedule_key_deletion(key_id, schedule_key_deletion_details, opts = {}) logger.debug 'Calling operation KmsManagementClient#schedule_key_deletion.' if logger raise "Missing the required parameter 'key_id' when calling schedule_key_deletion." if key_id.nil? raise "Missing the required parameter 'schedule_key_deletion_details' when calling schedule_key_deletion." if schedule_key_deletion_details.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}/actions/scheduleDeletion'.sub('{keyId}', key_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[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(schedule_key_deletion_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#schedule_key_deletion') 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::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |
#update_key(key_id, update_key_details, opts = {}) ⇒ Response
Updates the properties of a key. Specifically, you can update the ‘displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the key must in an `ACTIVE` or `CREATING` state to be updated.
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 924 925 926 927 |
# File 'lib/oci/key_management/kms_management_client.rb', line 889 def update_key(key_id, update_key_details, opts = {}) logger.debug 'Calling operation KmsManagementClient#update_key.' if logger raise "Missing the required parameter 'key_id' when calling update_key." if key_id.nil? raise "Missing the required parameter 'update_key_details' when calling update_key." if update_key_details.nil? raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id) path = '/20180608/keys/{keyId}'.sub('{keyId}', key_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[:'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 post_body = @api_client.object_to_http_body(update_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'KmsManagementClient#update_key') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::KeyManagement::Models::Key' ) end # rubocop:enable Metrics/BlockLength end |