Метод get
Возвращает указанный ресурс Key.
Чтобы получить список доступных ресурсов Key, используйте запрос list.
HTTP-запрос
GET https://iam.api.cloud.yandex.net/iam/v1/keys/{keyId}
Path-параметры
Параметр | Описание |
---|---|
keyId | Обязательное поле. Идентификатор возвращаемого ресурса Key. Чтобы получить идентификатор, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
format | Формат ключа.
|
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"createdAt": "string",
"description": "string",
"keyAlgorithm": "string",
"publicKey": "string",
// включает только одно из полей `userAccountId`, `serviceAccountId`
"userAccountId": "string",
"serviceAccountId": "string",
// конец списка возможных полей
}
Ресурс Key. Подробнее см. в разделе Авторизованные ключи.
Поле | Описание |
---|---|
id | string Идентификатор ресурса Key |
createdAt | string (date-time) Время создания. Строка в формате RFC3339. |
description | string Описание ресурса Key. Длина 0-256 символов. |
keyAlgorithm | string Алгоритм, используемый для создания пары ключей ресурса Key.
|
publicKey | string Закрытый ключ из ресурса Key. |
userAccountId | string включает только одно из полей userAccountId , serviceAccountId Идентификатор аккаунта пользователя, которому принадлежит ресурс Key. |
serviceAccountId | string включает только одно из полей userAccountId , serviceAccountId Идентификатор сервисного аккаунта, которому принадлежит ресурс Key. |