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
Key | Datatype | Required | Description |
---|---|---|---|
if-match | string | 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. | |||
opc-request-id | string | 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. | |||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","displayName":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","lifecycleState":"DISABLING","vaultId":"\u003cstring\u003e","keyShape":{"algorithm":"RSA","length":"\u003cinteger\u003e","curveId":"NIST_P384"},"currentKeyVersion":"\u003cstring\u003e","definedTags":{"Lorem_59":{"dolorb":{}},"ade_":{"culpa_cc0":{},"nulla_4a":{},"voluptate_a":{}},"dolore8":{"laboref5":{}}},"freeformTags":{"idbf":"\u003cstring\u003e"},"isPrimary":"\u003cboolean\u003e","protectionMode":"SOFTWARE","replicaDetails":{"replicationId":"\u003cstring\u003e"},"restoredFromKeyId":"\u003cstring\u003e","timeOfDeletion":"\u003cdateTime\u003e"}