Models

1: DatakeyRequest
2: DatakeyResponse
3: DecryptRequest
4: DecryptResponse
5: EncryptRequest
6: EncryptResponse
7: HmacRequest
8: HmacResponse
9: HmacVerifyRequest
10: HmacVerifyResponse
11: Key
12: KeyCreateMasterKeyRequest
13: KeyDescriptionRequest
14: KeyNameDuplicateResponse
15: KeyPageResponse
16: KeyRotateInfoRequest
17: KeyShowResponse
18: KeyStateRequest
19: KeyUserResponse
20: RewrapRequest
21: RewrapResponse
22: SignRequest
23: SignResponse
24: Tag
25: User
26: VerifyRequest
27: VerifyResponse

1 - DatakeyRequest

Name	Description	Schema	Default
key_type required	Key type( plaintext or wrapped ) Example : `plaintext`	string

2 - DatakeyResponse

Name	Description	Schema
ciphertext required	Encrypted data key Example : `vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string
key_version required	Version of KMS key Example : `1`	integer
plaintext required	Data key(base64 encoded) Example : `oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=`	any of [string, null]

3 - DecryptRequest

Name	Description	Schema	Default
ciphertext required	Encrypted data by KMS Example : `vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string

4 - DecryptResponse

Name	Description	Schema	Default
plaintext required	Decrypted data(base64 encoded) Example : `dGhlIHF1aWNrIGJyb3duIGZveAo=`	string

5 - EncryptRequest

Name	Description	Schema	Default
plaintext required	Data(base64 encoded) to encrypt Example : `dGhlIHF1aWNrIGJyb3duIGZveAo=`	string

6 - EncryptResponse

Name	Description	Schema	Default
ciphertext required	Encrypted data by KMS Example : `vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string
key_version required	Version of KMS key Example : `1`	integer

7 - HmacRequest

Name	Description	Schema	Default
input required	Data(base64 encoded) for verification Example : `dGVzdCBpbnB1dA==`	string

8 - HmacResponse

Name	Description	Schema	Default
hmac required	HMAC data Example : `vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=`	string

9 - HmacVerifyRequest

Name	Description	Schema	Default
hmac required	Signature data Example : `vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`	string
input required	Data(base64 encoded) for verification Example : `dGVzdCBpbnB1dA==`	string

10 - HmacVerifyResponse

Name	Description	Schema	Default
valid required	Verify result Example : `True`	boolean

11 - Key

Name	Description	Schema
account_id required	Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
auto_rotate required	Auto rotate Y or N Example : `Y`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
current_version required	Current version of KMS key Example : `7`	integer
delete_at required	Date of deletion Example : `20251008`	any of [string (date-time), null]
delete_target_yn required	DeleteTargetYn of Key Example : `Y`	any of [string, null]
description required	Description of Key Example : `description1` Maximum length : `100`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
key_type required	basic or advanced Example : `advanced`	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Name of key Example : `testkey` Pattern : `^[a-z0-9]$` Minimum length* : `3` Maximum length : `63`	string
next_rotate_at required	Date of next rotate Example : `20241008`	any of [string (date-time), null]
order_ref required	Reference of order Example : `0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01`	any of [string, null]
purpose required	Purpose of key Example : `rsa-2048`	string
region required	Name of region Example : `kr-west1`	string
rotate_cycle required	Rotation cycle Example : `7`	integer
secret_ref required	Reference of secret Example : `0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01`	any of [string, null]
state required	State of key(Creating, Active, Error, Stop, To_Be_Terminated) Example : `Active`	any of [string, null]
use_count required	Use count of KMS key Example : `1004`	integer

12 - KeyCreateMasterKeyRequest

Name	Description	Schema	Default
auto_rotate required	Auto rotate Y or N Example : `Y`	string
description required	Description of Key Example : `description1` Maximum length : `100`	string
key_type optional	basic or advanced Example : `advanced`	enum (basic, advanced)	advanced
name required	Name of key Example : `testkey` Pattern : `^[a-z0-9]$` Minimum length* : `3` Maximum length : `63`	string
purpose required	Purpose of key Example : `rsa-2048`	string
rotate_cycle required	Rotation cycle Example : `7`	integer
tags optional	Tag List’	array[Tag]

13 - KeyDescriptionRequest

Name	Description	Schema	Default
description required	Description of Key Example : Maximum length : `100`	string

14 - KeyNameDuplicateResponse

Name	Description	Schema	Default
isDuplicateName optional	Example : `True`	boolean	Duplicate check result

15 - KeyPageResponse

Name	Description	Schema
count required	count Example : `20`	integer
keys required		array[Key]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

16 - KeyRotateInfoRequest

Name	Description	Schema	Default
auto_rotate required	Auto rotate Y or N Example : `Y` Pattern : `^[YN]$`	string
rotate_cycle required	Rotation cycle Example : `7`	any of [integer, null]

17 - KeyShowResponse

Name	Description	Schema	Default
key required		Key

18 - KeyStateRequest

Name	Description	Schema	Default
state required	State of key(Active, Stop) Example : `Active` Pattern : `^(Active\|Stop)$`	string

19 - KeyUserResponse

Name	Description	Schema	Default
user required		array[User]

20 - RewrapRequest

Name	Description	Schema	Default
ciphertext required	Encrypted data by KMS Example : `vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string

21 - RewrapResponse

Name	Description	Schema	Default
ciphertext required	Rewrapped data by KMS Example : `vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string
key_version required	Version of KMS key Example : `1`	integer

22 - SignRequest

Name	Description	Schema	Default
input required	Data(base64 encoded) for Signature Example : `dGVzdCBpbnB1dA==`	string

23 - SignResponse

Name	Description	Schema	Default
key_version required	Version of KMS key Example : `1`	integer
signature required	Signature data Example : `vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`	string

24 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

25 - User

Name	Description	Schema	Default
user_id required	User ID Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string
user_name required	User Name Example : `kimsamsung`	string

26 - VerifyRequest

Name	Description	Schema	Default
input required	Data(base64 encoded) for verification Example : `dGVzdCBpbnB1dA==`	string
signature required	Signature data Example : `vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`	string

27 - VerifyResponse

Name	Description	Schema	Default
valid required	Verify result Example : `True`	boolean