Key Management Service API, gRPC: AsymmetricSignatureKeyService.Update
Updates the specified asymmetric KMS key.
gRPC request
rpc Update (UpdateAsymmetricSignatureKeyRequest) returns (operation.Operation)
UpdateAsymmetricSignatureKeyRequest
{
"keyId": "string",
"updateMask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"status": "Status",
"labels": "string",
"deletionProtection": "bool"
}
Field |
Description |
keyId |
string Required field. ID of the asymmetric KMS key to update. |
updateMask |
Required field. Field mask that specifies which attributes of the asymmetric KMS key are going to be updated. |
name |
string New name for the asymmetric KMS key. |
description |
string New description for the asymmetric KMS key. |
status |
enum Status New status for the asymmetric KMS key.
|
labels |
string Custom labels for the asymmetric KMS key as |
deletionProtection |
bool Flag that inhibits deletion of the asymmetric KMS key |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"keyId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"status": "Status",
"signatureAlgorithm": "AsymmetricSignatureAlgorithm",
"deletionProtection": "bool"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
UpdateAsymmetricSignatureKeyMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateAsymmetricSignatureKeyMetadata
Field |
Description |
keyId |
string ID of the key being updated. |
AsymmetricSignatureKey
An asymmetric KMS key that may contain several versions of the cryptographic material.
Field |
Description |
id |
string ID of the key. |
folderId |
string ID of the folder that the key belongs to. |
createdAt |
Time when the key was created. |
name |
string Name of the key. |
description |
string Description of the key. |
labels |
string Custom labels for the key as |
status |
enum Status Current status of the key.
|
signatureAlgorithm |
enum AsymmetricSignatureAlgorithm Signature Algorithm ID.
|
deletionProtection |
bool Flag that inhibits deletion of the key |