This is the multi-page printable view of this section. Click here to print.
Decrypt Data
1 - 1.2
scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>
Description
Decrypts the provided ciphertext using key(Purpose: encryption/decryption).
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | Encrypted data by KMS | vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| plaintext | Decrypted data(base64 encoded) | dGhlIHF1aWNrIGJyb3duIGZveAo= |
2 - 1.1
scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>
Description
Decrypts the provided ciphertext using key(Purpose: encryption/decryption).
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | Encrypted data by KMS | vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| plaintext | Decrypted data(base64 encoded) | dGhlIHF1aWNrIGJyb3duIGZveAo= |
3 - 1.0
scpcli kms kms decrypt
--key_id <value>
--ciphertext <value>
Description
Decrypts the provided ciphertext using key(Purpose: encryption/decryption).
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| ciphertext required | string | Encrypted data by KMS | vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
Responses
| Name | Description | Example |
|---|---|---|
| plaintext | Decrypted data(base64 encoded) | dGhlIHF1aWNrIGJyb3duIGZveAo= |