Updates a key's properties.

PUT {{managementEndpoint}}/20180608/keys/:keyId

Updates the properties of a master encryption key. Specifically, you can update the displayName, freeformTags, and definedTags properties. Furthermore, the key must be in an ENABLED or CREATING state to be updated.

As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

Request Body

{"displayName"=>"<string>", "freeformTags"=>{"nostrud4e3"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
if-matchstringFor 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.
opc-request-idstringUnique 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.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;compartmentId&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;,&quot;timeCreated&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;lifecycleState&quot;:&quot;DISABLING&quot;,&quot;vaultId&quot;:&quot;\u003cstring\u003e&quot;,&quot;keyShape&quot;:{&quot;algorithm&quot;:&quot;RSA&quot;,&quot;length&quot;:&quot;\u003cinteger\u003e&quot;,&quot;curveId&quot;:&quot;NIST_P384&quot;},&quot;currentKeyVersion&quot;:&quot;\u003cstring\u003e&quot;,&quot;definedTags&quot;:{&quot;Lorem_59&quot;:{&quot;dolorb&quot;:{}},&quot;ade_&quot;:{&quot;culpa_cc0&quot;:{},&quot;nulla_4a&quot;:{},&quot;voluptate_a&quot;:{}},&quot;dolore8&quot;:{&quot;laboref5&quot;:{}}},&quot;freeformTags&quot;:{&quot;idbf&quot;:&quot;\u003cstring\u003e&quot;},&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;protectionMode&quot;:&quot;SOFTWARE&quot;,&quot;replicaDetails&quot;:{&quot;replicationId&quot;:&quot;\u003cstring\u003e&quot;},&quot;restoredFromKeyId&quot;:&quot;\u003cstring\u003e&quot;,&quot;timeOfDeletion&quot;:&quot;\u003cdateTime\u003e&quot;}