Identity and Access Management API, REST: Key.Update
Updates the specified key pair.
HTTP request
PATCH https://iam.api.cloud.yandex.net/iam/v1/keys/{keyId}
Path parameters
Field |
Description |
keyId |
string Required field. ID of the Key resource to update. |
Body parameters
{
"updateMask": "string",
"description": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
description |
string Description of the key pair. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"keyId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
// Includes only one of the fields `userAccountId`, `serviceAccountId`
"userAccountId": "string",
"serviceAccountId": "string",
// end of the list of possible fields
"createdAt": "string",
"description": "string",
"keyAlgorithm": "string",
"publicKey": "string",
"lastUsedAt": "string"
}
// 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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
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. |
UpdateKeyMetadata
Field |
Description |
keyId |
string ID of the Key resource that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Key
A Key resource. For more information, see Authorized keys.
Field |
Description |
id |
string ID of the Key resource. |
userAccountId |
string ID of the user account that the Key resource belongs to. Includes only one of the fields |
serviceAccountId |
string ID of the service account that the Key resource belongs to. Includes only one of the fields |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
description |
string Description of the Key resource. 0-256 characters long. |
keyAlgorithm |
enum (Algorithm) An algorithm used to generate a key pair of the Key resource.
|
publicKey |
string A public key of the Key resource. |
lastUsedAt |
string (date-time) Timestamp for the last use of this key. String in RFC3339 To work with values in this field, use the APIs described in the |