This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

CLIs

1: Change Rotate Info

1.1: 1.2
1.2: 1.1
1.3: 1.0

2: Change State Of Key

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Check Duplicate Name

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Create Datakey

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Create Key

5.1: 1.2
5.2: 1.1
5.3: 1.0

6: Decrypt Data

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Delete Key

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: Encrypt Data

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: List Keys

9.1: 1.2
9.2: 1.1
9.3: 1.0

10: List Managed Keys

10.1: 1.2

11: List Users

11.1: 1.2
11.2: 1.1
11.3: 1.0

12: Make hmac

12.1: 1.2
12.2: 1.1
12.3: 1.0

13: Rewrap Data

13.1: 1.2
13.2: 1.1
13.3: 1.0

14: Rotate Key

14.1: 1.2
14.2: 1.1
14.3: 1.0

15: Show Key

15.1: 1.2
15.2: 1.1
15.3: 1.0

16: Show Managed Key

16.1: 1.2

17: Sign Data

17.1: 1.2
17.2: 1.1
17.3: 1.0

18: Update Description

18.1: 1.2
18.2: 1.1
18.3: 1.0

19: Update Managed Key Description

19.1: 1.2

20: Verify Data

20.1: 1.2
20.2: 1.1
20.3: 1.0

21: Verify hmac with input

21.1: 1.2
21.2: 1.1
21.3: 1.0

1 - Change Rotate Info

1.1 - 1.2

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

Change rotate info.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
rotate_cycle required	integer	Rotation cycle	`7`
auto_rotate required	string	Auto rotate Y or N	`Y`

1.2 - 1.1

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

Change rotate info.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
rotate_cycle required	integer	Rotation cycle	`7`
auto_rotate required	string	Auto rotate Y or N	`Y`

1.3 - 1.0

scpcli kms kms change rotate info
--key_id <value>
--rotate_cycle <value>
--auto_rotate <value>

Description

Change rotate info.

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`
rotate_cycle required	integer	Rotation cycle	`7`
auto_rotate required	string	Auto rotate Y or N	`Y`

2 - Change State Of Key

2.1 - 1.2

scpcli kms kms change state
--key_id <value>
--state <value>

Description

Change state of key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
state required	string	State of key(Active, Stop)	`Active`

2.2 - 1.1

scpcli kms kms change state
--key_id <value>
--state <value>

Description

Change state of key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
state required	string	State of key(Active, Stop)	`Active`

2.3 - 1.0

scpcli kms kms change state
--key_id <value>
--state <value>

Description

Change state of key.

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`
state required	string	State of key(Active, Stop)	`Active`

3 - Check Duplicate Name

3.1 - 1.2

scpcli kms kms check duplicate name
--name <value>

Description

Check duplication of key name.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
name required	string	Name of key	`testkey`

Responses

Name	Description	Example
isDuplicateName		True

3.2 - 1.1

scpcli kms kms check duplicate name
--name <value>

Description

Check duplication of key name.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
name required	string	Name of key	`testkey`

Responses

Name	Description	Example
isDuplicateName		True

3.3 - 1.0

scpcli kms kms check duplicate name
--name <value>

Description

Check duplication of key name.

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
name required	string	Name of key	`testkey`

Responses

Name	Description	Example
isDuplicateName		True

4 - Create Datakey

4.1 - 1.2

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

Generates a new key and the value encrypted with 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`
key_type required	string	Key type( plaintext or wrapped )	`plaintext`

Responses

Name	Description	Example
ciphertext	Encrypted data key	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1
plaintext	Data key(base64 encoded)	oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

4.2 - 1.1

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

Generates a new key and the value encrypted with 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`
key_type required	string	Key type( plaintext or wrapped )	`plaintext`

Responses

Name	Description	Example
ciphertext	Encrypted data key	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1
plaintext	Data key(base64 encoded)	oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

4.3 - 1.0

scpcli kms kms datakey
--key_id <value>
--key_type <value>

Description

Generates a new key and the value encrypted with 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`
key_type required	string	Key type( plaintext or wrapped )	`plaintext`

Responses

Name	Description	Example
ciphertext	Encrypted data key	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1
plaintext	Data key(base64 encoded)	oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

5 - Create Key

5.1 - 1.2

scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]

Description

Create key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
rotate_cycle required	integer	Rotation cycle	`7`
purpose required	string	Purpose of key	`rsa-2048`
name required	string	Name of key	`testkey`
description required	string	Description of Key	`description1`
auto_rotate required	string	Auto rotate Y or N	`Y`
key_type optional	string	basic or advanced	`advanced`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
managed_type	scp or user	user
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

5.2 - 1.1

scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]

Description

Create key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
rotate_cycle required	integer	Rotation cycle	`7`
purpose required	string	Purpose of key	`rsa-2048`
name required	string	Name of key	`testkey`
description required	string	Description of Key	`description1`
auto_rotate required	string	Auto rotate Y or N	`Y`
key_type optional	string	basic or advanced	`advanced`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

5.3 - 1.0

scpcli kms kms create
--rotate_cycle <value>
--purpose <value>
--name <value>
--description <value>
--auto_rotate <value>
[--key_type <value>]
[--tags <value>]

Description

Create key.

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
rotate_cycle required	integer	Rotation cycle	`7`
purpose required	string	Purpose of key	`rsa-2048`
name required	string	Name of key	`testkey`
description required	string	Description of Key	`description1`
auto_rotate required	string	Auto rotate Y or N	`Y`
key_type optional	string	basic or advanced	`advanced`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

6 - Decrypt Data

6.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=

6.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=

6.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=

7 - Delete Key

7.1 - 1.2

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

Delete a key now or later.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
is_directly optional	boolean	Delete immediately	`True`

7.2 - 1.1

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

Delete a key now or later.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
is_directly optional	boolean	Delete immediately	`True`

7.3 - 1.0

scpcli kms kms delete
--key_id <value>
[--is_directly <value>]

Description

Delete a key now or later.

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`
is_directly optional	boolean	Delete immediately	`True`

8 - Encrypt Data

8.1 - 1.2

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

Encrypts the provided plaintext(base64 encoded) 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`
plaintext required	string	Data(base64 encoded) to encrypt	`dGhlIHF1aWNrIGJyb3duIGZveAo=`

Responses

Name	Description	Example
ciphertext	Encrypted data by KMS	vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

8.2 - 1.1

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

Encrypts the provided plaintext(base64 encoded) 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`
plaintext required	string	Data(base64 encoded) to encrypt	`dGhlIHF1aWNrIGJyb3duIGZveAo=`

Responses

Name	Description	Example
ciphertext	Encrypted data by KMS	vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

8.3 - 1.0

scpcli kms kms encrypt
--key_id <value>
--plaintext <value>

Description

Encrypts the provided plaintext(base64 encoded) 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`
plaintext required	string	Data(base64 encoded) to encrypt	`dGhlIHF1aWNrIGJyb3duIGZveAo=`

Responses

Name	Description	Example
ciphertext	Encrypted data by KMS	vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

9 - List Keys

9.1 - 1.2

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

List keys.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of key	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
managed_type	scp or user	user
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

9.2 - 1.1

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

List keys.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of key	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

9.3 - 1.0

scpcli kms kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

List keys.

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
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of key	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

10 - List Managed Keys

10.1 - 1.2

scpcli kms managed-kms list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

List keys.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Name of key	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
managed_type	scp or user	user
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

11 - List Users

11.1 - 1.2

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
user_id	User ID	138c2fc8c29a449dbfa8681f8f1d78e2
user_name	User Name	kimsamsung

11.2 - 1.1

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
user_id	User ID	138c2fc8c29a449dbfa8681f8f1d78e2
user_name	User Name	kimsamsung

11.3 - 1.0

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

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`

Responses

Name	Description	Example
user_id	User ID	138c2fc8c29a449dbfa8681f8f1d78e2
user_name	User Name	kimsamsung

12 - Make hmac

12.1 - 1.2

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

Generates a HMAC using key(Purpose: create/verification).

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
hmac	HMAC data	vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

12.2 - 1.1

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

Generates a HMAC using key(Purpose: create/verification).

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
hmac	HMAC data	vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

12.3 - 1.0

scpcli kms kms generate hmac
--key_id <value>
--input <value>

Description

Generates a HMAC using key(Purpose: create/verification).

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`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
hmac	HMAC data	vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

13 - Rewrap Data

13.1 - 1.2

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

Rewraps the provided ciphertext using the latest version of 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:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
ciphertext	Rewrapped data by KMS	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

13.2 - 1.1

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

Rewraps the provided ciphertext using the latest version of 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:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
ciphertext	Rewrapped data by KMS	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

13.3 - 1.0

scpcli kms kms rewrap
--key_id <value>
--ciphertext <value>

Description

Rewraps the provided ciphertext using the latest version of 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:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
ciphertext	Rewrapped data by KMS	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	Version of KMS key	1

14 - Rotate Key

14.1 - 1.2

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

14.2 - 1.1

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

14.3 - 1.0

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

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`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

15 - Show Key

15.1 - 1.2

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
managed_type	scp or user	user
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

15.2 - 1.1

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

15.3 - 1.0

scpcli kms kms show
--key_id <value>

Description

Show key.

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`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

16 - Show Managed Key

16.1 - 1.2

scpcli kms managed-kms show
--key_id <value>

Description

Show key.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	Account ID	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	Auto rotate Y or N	Y
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
current_version	Current version of KMS key	7
delete_at	Date of deletion	20251008
delete_target_yn	DeleteTargetYn of Key	Y
description	Description of Key	description1
key_type	basic or advanced	advanced
managed_type	scp or user	user
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Name of key	testkey
next_rotate_at	Date of next rotate	20241008
order_ref	Reference of order	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	Purpose of key	rsa-2048
region	Name of region	kr-west1
rotate_cycle	Rotation cycle	7
secret_ref	Reference of secret	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	State of key(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	Use count of KMS key	1004

17 - Sign Data

17.1 - 1.2

scpcli kms kms sign
--key_id <value>
--input <value>

Description

Returns the cryptographic signature of the given data using key(Purpose: signature/verification).

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for Signature	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
key_version	Version of KMS key	1
signature	Signature data	vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

17.2 - 1.1

scpcli kms kms sign
--key_id <value>
--input <value>

Description

Returns the cryptographic signature of the given data using key(Purpose: signature/verification).

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for Signature	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
key_version	Version of KMS key	1
signature	Signature data	vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

17.3 - 1.0

scpcli kms kms sign
--key_id <value>
--input <value>

Description

Returns the cryptographic signature of the given data using key(Purpose: signature/verification).

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`
input required	string	Data(base64 encoded) for Signature	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
key_version	Version of KMS key	1
signature	Signature data	vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

18 - Update Description

18.1 - 1.2

scpcli kms kms update description
--key_id <value>
--description <value>

Description

Update description.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
description required	string	Description of Key	-

18.2 - 1.1

scpcli kms kms update description
--key_id <value>
--description <value>

Description

Update description.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
description required	string	Description of Key	-

18.3 - 1.0

scpcli kms kms update description
--key_id <value>
--description <value>

Description

Update description.

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`
description required	string	Description of Key	-

19 - Update Managed Key Description

19.1 - 1.2

scpcli kms managed-kms update description
--key_id <value>
--description <value>

Description

Update description.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
description required	string	Description of Key	`description1`

20 - Verify Data

20.1 - 1.2

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

Returns whether the provided signature is valid for the given data from either the sign data using key(Purpose: signature/verification).

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
signature required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
valid	Verify result	True

20.2 - 1.1

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

Returns whether the provided signature is valid for the given data from either the sign data using key(Purpose: signature/verification).

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
signature required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
valid	Verify result	True

20.3 - 1.0

scpcli kms kms verify
--key_id <value>
--signature <value>
--input <value>

Description

Returns whether the provided signature is valid for the given data from either the sign data using key(Purpose: signature/verification).

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`
signature required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
valid	Verify result	True

21 - Verify hmac with input

21.1 - 1.2

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

Returns whether the INPUT value is VALID or not using key(Purpose: create/verification).

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`
hmac required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`

Responses

Name	Description	Example
valid	Verify result	True

21.2 - 1.1

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

Returns whether the INPUT value is VALID or not using key(Purpose: create/verification).

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Name	Type	Description	Example
key_id required	string	Resource id of KMS key	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`
hmac required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`

Responses

Name	Description	Example
valid	Verify result	True

21.3 - 1.0

scpcli kms kms verify hmac
--key_id <value>
--input <value>
--hmac <value>

Description

Returns whether the INPUT value is VALID or not using key(Purpose: create/verification).

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`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`
hmac required	string	Signature data	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`

Responses

Name	Description	Example
valid	Verify result	True