Encrypt
- Print
- PDF
Encrypt
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Summary
Up to 32 KB data are encrypted with the current version of the specified master key. The request can only be made with the key type used for encryption and decryption.
POST https://kms.apigw.ntruss.com/keys/v1/{keyTag}/encrypt
POST https://kms.apigw.ntruss.com/keys/v2/{keyTag}/encrypt
Request
Request parameters
| Parameter name | Type | Description |
|---|---|---|
| keyTag | String (Required) | Tag value of the master key to use for the encryption |
Request body
{
"plaintext" : string or string list,
"context" : string
}
| Parameter name | Type | Description |
|---|---|---|
| plaintext | String or String List (Required) | - Data to encrypt (up to 32 KB) Need to be Base64-encoded List can be up to 32 KB for all items combined |
| context | String (Optional) | - Context data (up to 50 bytes) Need to be Base64-encoded Required only for AES-256 key type with convergent encryption |
Request body example
{
"plaintext" : "dGVzdA==",
"context" : "dGhpcyBpcyBhIHRlc3QgY29udGV4dA=="
}
or
{
"plaintext" : ["dGVzdA==", "dGVzdDI=", "dGVzdDM="],
"context" : "dGhpcyBpcyBhIHRlc3QgY29udGV4dA=="
}
Response
Response body
{
"ciphertext" : string
}
or
{
"ciphertextList" : [string, string, string]
}
| Parameter name | Type | Description |
|---|---|---|
| ciphertext | String | - Ciphertext data Consist of a KMS prefix and a Base64-encoded ciphertext Returned if requested as a string type |
| ciphertextList | String List | - Ciphertext data Consist of a KMS prefix and a Base64-encoded ciphertext Returned if requested as a string list type |
Was this article helpful?