lib/oci/key_management/kms_management_client.rb
# Disables a key to make it unavailable for encryption
# or decryption.
#
# @param [String] key_id The OCID of the key.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
#   resource, set the `if-match` parameter to the value of the etag from a
#   previous GET or POST response for that resource. The resource will be
#   updated or deleted only if the etag you provide matches the resource's
#   current etag value.
#
# @option opts [String] :opc_request_id Unique identifier for the request. If provided, the returned request ID
#   will include this value. Otherwise, a random request ID will be
#   generated by the service.
#
# @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case
#   of a timeout or server error without risk of executing that same action
#   again. Retry tokens expire after 24 hours, but can be invalidated
#   before then due to conflicting operations (e.g., if a resource has been
#   deleted and purged from the system, then a retry of the original
#   creation request may be rejected).
#
# @return [Response] A Response object with data of type {OCI::KeyManagement::Models::Key Key}
Disables a key to make it unavailable for encryption
or decryption.
Disables a key to make it unavailable for encryption or decryption .
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
      query_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]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = nil
      OCI::Retry.make_retrying_call(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
    end
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 query_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 ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = nil OCI :: Retry . make_retrying_call ( 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 end
Disables a key to make it unavailable for encryption
or decryption.
Disables a key to make it unavailable for encryption or decryption .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::KeyManagement::Models::Key Key}
A Response object with data of type { OCI :: KeyManagement :: Models :: Key Key }
Response
key_id
opts
:opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations .
: opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again . Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations .
opts the optional parameters
opts the optional parameters