Identity and Access Management API, REST: Key.Get
Returns the specified Key resource.
To get the list of available Key resources, make a List request.
HTTP request
GET https://iam.api.cloud.yandex.net/iam/v1/keys/{keyId}
Path parameters
|
Field |
Description |
|
keyId |
string Required field. ID of the Key resource to return. The maximum string length in characters is 50. |
Query parameters
|
Field |
Description |
|
format |
enum (KeyFormat) Output format of the key.
|
Response
HTTP Code: 200 - OK
{
"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"
}
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 text format. The range of possible values is from 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 text format. The range of possible values is from To work with values in this field, use the APIs described in the |