Метод create

Создает пару ключей для указанного сервисного аккаунта.

HTTP-запрос

POST https://iam.api.cloud.yandex.net/iam/v1/keys

Параметры в теле запроса

{
  "serviceAccountId": "string",
  "description": "string",
  "format": "string",
  "keyAlgorithm": "string"
}
Поле Описание
serviceAccountId string

Идентификатор сервисного аккаунта для создания пары ключей. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list. Если параметр не указан, то используется идентификатор субъекта, который сделал запрос.

Максимальная длина строки в символах — 50.

description string

Описание пары ключей.

Максимальная длина строки в символах — 256.

format string

Формат ключа.

  • PEM_FILE: Формат Privacy-Enhanced Mail (PEM). Значение по умолчанию.
keyAlgorithm string

Алгоритм, используемый для создания пары ключей ресурса Key.

  • RSA_2048: RSA с длиной ключа 2048 бит. Значение по умолчанию.
  • RSA_4096: RSA с длиной ключа 4096 бит.

Ответ

HTTP Code: 200 - OK

{
  "key": {
    "id": "string",
    "createdAt": "string",
    "description": "string",
    "keyAlgorithm": "string",
    "publicKey": "string",

    // `key` включает только одно из полей `userAccountId`, `serviceAccountId`
    "userAccountId": "string",
    "serviceAccountId": "string",
    // конец списка возможных полей`key`

  },
  "privateKey": "string"
}
Поле Описание
key object

Ресурс Key.

Ресурс Key. Подробнее см. в разделе Авторизованные ключи.

key.
id
string

Идентификатор ресурса Key

key.
createdAt
string (date-time)

Время создания.

Строка в формате RFC3339.

key.
description
string

Описание ресурса Key. Длина 0-256 символов.

key.
keyAlgorithm
string
Алгоритм, используемый для создания пары ключей ресурса Key.
  • RSA_2048: RSA с длиной ключа 2048 бит. Значение по умолчанию.
  • RSA_4096: RSA с длиной ключа 4096 бит.
key.
publicKey
string

Закрытый ключ из ресурса Key.

key.
userAccountId
string
key включает только одно из полей userAccountId, serviceAccountId

Идентификатор аккаунта пользователя, которому принадлежит ресурс Key.

key.
serviceAccountId
string
key включает только одно из полей userAccountId, serviceAccountId

Идентификатор сервисного аккаунта, которому принадлежит ресурс Key.

privateKey string

Закрытый ключ из ресурса Key. Этот ключ должен храниться в надежном месте.