Метод encrypt
Шифрует заданный текст с помощью указанного ключа.
HTTP-запрос
POST https://kms.yandex/kms/v1/keys/{keyId}:encrypt
Path-параметры
| Параметр | Описание |
|---|---|
| keyId | Обязательное поле. Идентификатор симметричного ключа KMS, который следует использовать для шифрования. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"versionId": "string",
"aadContext": "string",
"plaintext": "string"
}
| Поле | Описание |
|---|---|
| versionId | string Идентификатор версии ключа, которую следует использовать для шифрования текста. По умолчанию используется основная версия, если версия не указана явно. Максимальная длина строки в символах — 50. |
| aadContext | string (byte) Дополнительные аутентифицированные данные (контекст AAD), необязательное поле. Если данные указаны, то их потребуется передать для расшифровки с помощью Максимальная длина строки в символах — 8192. |
| plaintext | string (byte) Обязательное поле. Открытый текст, который следует зашифровать. Должен быть в кодировке base64. Максимальная длина строки в символах — 32768. |
Ответ
HTTP Code: 200 - OK
{
"keyId": "string",
"versionId": "string",
"ciphertext": "string"
}
| Поле | Описание |
|---|---|
| keyId | string Обязательное поле. Идентификатор симметричного ключа KMS, который использовался для шифрования. Максимальная длина строки в символах — 50. |
| versionId | string Идентификатор версии ключа, которая использовалась для шифрования. Максимальная длина строки в символах — 50. |
| ciphertext | string (byte) Полученный шифртекст. |