Identity and Access Management API, REST: Key.Create
Creates a key pair for the specified service account.
HTTP request
POST https://iam.api.cloud.yandex.net/iam/v1/keys
Body parameters
{
"serviceAccountId": "string",
"description": "string",
"format": "string",
"keyAlgorithm": "string"
}
Field |
Description |
serviceAccountId |
string ID of the service account to create a key pair for. |
description |
string Description of the key pair. |
format |
enum (KeyFormat) Output format of the key.
|
keyAlgorithm |
enum (Algorithm) An algorithm used to generate a key pair of the Key resource.
|
Response
HTTP Code: 200 - OK
{
"key": {
"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"
},
"privateKey": "string"
}
Field |
Description |
key |
Key resource. |
privateKey |
string A private key of the Key resource. |
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 |