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

Return to the regular view of this page.

Security

1 - Certificate Manager

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Certificate Manager service and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

1.1 - CLIs

1.1.1 - Check duplicate name

1.1.1.1 - 1.1

scpcli certificatemanager certificate check
--name <value>

Description

Check duplication name

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.1.1.2 - 1.0

scpcli certificatemanager certificate check
--name <value>

Description

Check duplication 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.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.1.2 - Create a certificate

1.1.2.1 - 1.1

scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]

Description

Create a Certificate

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
private_key
required
stringPrivate key<encoded private_key data>
name
required
stringCertificate Nametest-certificate
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typePRD
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
recipientsExpired certificates Recipients[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
stateCertificate StateVALID
tagsTag List’
user_nameUser Namekildong@samsung.com

1.1.2.2 - 1.0

scpcli certificatemanager certificate create
--timezone <value>
--region <value>
--private_key <value>
--name <value>
--cert_body <value>
[--cert_chain <value>]
[--recipients <value>]
[--tags <value>]

Description

Create a Certificate

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
private_key
required
stringPrivate key<encoded private_key data>
name
required
stringCertificate Nametest-certificate
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typePRD
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
recipientsExpired certificates Recipients[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
stateCertificate StateVALID
tagsTag List’
user_nameUser Namekildong@samsung.com

1.1.3 - Delete a certificate

1.1.3.1 - 1.1

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

1.1.3.2 - 1.0

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

1.1.4 - Detail a certificate

1.1.4.1 - 1.1

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

1.1.4.2 - 1.0

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

1.1.5 - List certificates

1.1.5.1 - 1.1

scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]

Description

List Certificates

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanIs it my certificate-
name
optional
stringCertificate Nametest-certificate
cn
optional
stringCertificate Common Nametest.go.kr
state
optional
arrayCertificate StateV

Responses

NameDescriptionExample
idCertificate ID
cert_kindCertificate typePRD
cnCertificate Common Nametest.go.kr
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
stateCertificate StateVALID

1.1.5.2 - 1.0

scpcli certificatemanager certificate list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ismine <value>]
[--name <value>]
[--cn <value>]
[--state <value>]

Description

List Certificates

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanIs it my certificate-
name
optional
stringCertificate Nametest-certificate
cn
optional
stringCertificate Common Nametest.go.kr
state
optional
arrayCertificate StateV

Responses

NameDescriptionExample
idCertificate ID
cert_kindCertificate typePRD
cnCertificate Common Nametest.go.kr
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
stateCertificate StateVALID

1.1.6 - Self-sign a certificate

1.1.6.1 - 1.1

scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]

Description

Self-sign a Certificate

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
organization
required
stringCertificate Organization NamesamsungSDS
not_before_dt
required
stringCertificate Start Date20250101
not_after_dt
required
stringCertificate Expire Date20251212
name
required
stringCertificate Nametest-certificate
cn
required
stringCertificate Common Nametest.go.kr
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

1.1.6.2 - 1.0

scpcli certificatemanager certificate selfSign
--timezone <value>
--region <value>
--organization <value>
--not_before_dt <value>
--not_after_dt <value>
--name <value>
--cn <value>
[--recipients <value>]
[--tags <value>]

Description

Self-sign a Certificate

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
timezone
required
stringTimezoneAsia/Seoul
region
required
stringName of regionwest1
organization
required
stringCertificate Organization NamesamsungSDS
not_before_dt
required
stringCertificate Start Date20250101
not_after_dt
required
stringCertificate Expire Date20251212
name
required
stringCertificate Nametest-certificate
cn
required
stringCertificate Common Nametest.go.kr
recipients
optional
arrayExpired certificates Recipients'{"region": "", "user_id": "", "user_name": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount IDb82909b3576449fda984fb25c3123542da
cert_bodyCertificate body
cert_chainCertificate chain
cert_kindCertificate typeDEV
cert_typeCertificate typepem
cert_versionCertificate Version2
cnCertificate Common Nametest.go.kr
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
key_bit_sizekey bits size2048
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameCertificate Nametest-certificate
not_after_dtCertificate Expire Date2026-02-07T18:07:59
not_before_dtCertificate Start Date2025-02-08T18:07:00
organizationCertificate Organization NamesamsungSDS
private_keyPrivate key
stateCertificate StateVALID
user_nameUser Name2048

1.1.7 - Validate a certificate

1.1.7.1 - 1.1

scpcli certificatemanager certificate validate
--private_key <value>
--cert_body <value>
[--cert_chain <value>]

Description

Validate a Certificate

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
private_key
required
stringPrivate key<encoded private_key data>
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>

Responses

NameDescriptionExample
validate_check

1.1.7.2 - 1.0

scpcli certificatemanager certificate validate
--private_key <value>
--is_need_cert_chain <value>
--cert_body <value>
[--cert_chain <value>]

Description

Validate a Certificate

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
private_key
required
stringPrivate key<encoded private_key data>
is_need_cert_chain
required
booleanIs needed Certificate chainTrue
cert_body
required
stringCertificate body<encoded certificate body data>
cert_chain
optional
stringCertificate chain<encoded certificate chain data>

Responses

NameDescriptionExample
resultTrue, False CheckTrue

2 - Config Inspection

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Config Inspection and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0DEPRECATED20260531

2.1 - CLIs

2.1.1 - Create Config Inspection

2.1.1.1 - 1.1

scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]

Description

Create Diagnosis Object

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00

Responses

NameDescriptionExample
diagnosis_idId of diagnosisSample Diagnosis Name
resultTrue, False CheckTrue

2.1.1.2 - 1.0

scpcli configinspection ci create
--use_diagnosis_check_type_ssi <value>
--use_diagnosis_check_type_bp <value>
--frequency_value <value>
--frequency_type <value>
--diagnosis_start_time_pattern <value>
--auth_key_id <value>
--plan_type <value>
--diagnosis_type <value>
--diagnosis_name <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--diagnosis_account_id <value>
--csp_type <value>
--account_id <value>
[--tags <value>]
[--auth_key_created_at <value>]
[--auth_key_expired_at <value>]

Description

Create Diagnosis Object

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
use_diagnosis_check_type_ssi
required
stringChecklist SSI usagey
use_diagnosis_check_type_bp
required
stringChecklist Best Practice Usey
frequency_value
required
stringSchedule value (01~31, MONDAY~SUNDAY, everyDay)1
frequency_type
required
stringSchedule type( monthly, weekly, daily)MONTH
diagnosis_start_time_pattern
required
stringStart time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )08:00
auth_key_id
required
stringId of auth key9b72a9856e494e67afc69atd3631fe38
plan_type
required
stringplan TypeSTANDARD
diagnosis_type
required
stringdiagnosis TypeConsole
diagnosis_name
required
stringName of diagnosisSample Diagnosis Name
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
diagnosis_account_id
required
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
csp_type
required
stringType of cloud service providerSCP
account_id
required
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
tags
optional
arrayTag List'{"key": "", "value": ""}'
auth_key_created_at
optional
stringcreated date of authkey2022-01-01 12:00:00
auth_key_expired_at
optional
stringexpired date of authkey2023-01-01 12:00:00

Responses

NameDescriptionExample
resultTrue, False CheckTrue

2.1.2 - Delete Config Inspection

2.1.2.1 - 1.1

scpcli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

2.1.2.2 - 1.0

scpcli configinspection ci delete
--diagnosis_id <value>

Description

Delete Config Inspection Product

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

2.1.3 - Diagnosis Request

2.1.3.1 - 1.1

scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>

Description

Request diagnosis

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

2.1.3.2 - 1.0

scpcli configinspection ci diagnosis request
--tenant_id <value>
--secret_key <value>
--diagnosis_id <value>
--diagnosis_check_type <value>
--access_key <value>

Description

Request diagnosis

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
tenant_id
required
stringTenant ID1234567890
secret_key
required
stringSecret KeySAMPLE KEY
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_check_type
required
stringCheck type of diagnosisBP
access_key
required
stringAccess KeySAMPLE KEY

Responses

NameDescriptionExample
resultTrue, False CheckTrue

2.1.4 - Get Diagnosis Object Detail

2.1.4.1 - 1.1

scpcli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_atcreated date of authkey2022-01-01T12:00:00Z
auth_key_expired_atexpired date of authkey2022-01-01T12:00:00Z
auth_key_idId of auth key9b72a9856e494e67afc69atd3631fe38
auth_key_statestate of auth keyACTIVATED
user_iduser Id4f5d60e9e08b48d0a0881e21ab14e266

2.1.4.2 - 1.0

scpcli configinspection ci detail
--diagnosis_id <value>

Description

Get Diagnosis Object Detail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_id
required
stringId of diagnosisSample Diagnosis Name

Responses

NameDescriptionExample
auth_key_created_atcreated date of authkey2022-01-01T12:00:00Z
auth_key_expired_atexpired date of authkey2022-01-01T12:00:00Z
auth_key_idId of auth key9b72a9856e494e67afc69atd3631fe38
auth_key_statestate of auth keyACTIVATED
user_iduser Id4f5d60e9e08b48d0a0881e21ab14e266

2.1.5 - Get Diagnosis Result Detail

2.1.5.1 - 1.1

scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

get Diagnosis Result Detail

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guidemeasure guide description원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changediS Change result manageTrue
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_criteriadecision standard description【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_itemsub category description2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layerinspector item category description2.NETWORK
diagnosis_methodinspector method descriptionSecurity Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_resultverify result state03
result_contentsresult Contents상세 내역
sub_categorySub CategoryNURIBP_SCP_02.NW_004

2.1.5.2 - 1.0

scpcli configinspection ci result detail
--diagnosis_request_sequence <value>
--diagnosis_id <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

get Diagnosis Result Detail

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
diagnosis_request_sequence
required
stringSequence of diagnosis requestSCPCIS-E75FD21CA524441C9C1B1B381D5974F7
diagnosis_id
required
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
action_guidemeasure guide description원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changediS Change result manageTrue
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_criteriadecision standard description【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_itemsub category description2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layerinspector item category description2.NETWORK
diagnosis_methodinspector method descriptionSecurity Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_resultverify result state03
result_contentsresult Contents상세 내역
sub_categorySub CategoryNURIBP_SCP_02.NW_004

2.1.6 - List Config Inspection

2.1.6.1 - 1.1

scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]

Description

get config inspection list

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

2.1.6.2 - 1.0

scpcli configinspection ci list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ismine <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--csp_type <value>]
[--diagnosis_account_id <value>]
[--recent_diagnosis_state <value>]
[--start_date <value>]
[--end_date <value>]

Description

get config inspection list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ismine
optional
booleanmy Config InspectionFalse
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisMy Diagnosis
csp_type
optional
stringType of cloud service providerSCP
diagnosis_account_id
optional
stringId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
recent_diagnosis_state
optional
arrayrecent Diagnosis StateC
start_date
optional
stringstart Date2022-01-01 12:00:00
end_date
optional
stringend Date2022-01-02 12:00:00

Responses

NameDescriptionExample
created_atCreated date2022-01-01T12:00:00Z
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_typediagnosis TypeConsole
error_stateError type of recent diagnosisCONNECTION_FAIL
plan_typeplan TypeSTANDARD
recent_diagnosis_atrecent Diagnosis Date2022-01-01T12:00:00Z
recent_diagnosis_staterecent Diagnosis StateCompleted

2.1.7 - List Diagnosis Result

2.1.7.1 - 1.1

scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]

Description

get Diagnosis Result List

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

2.1.7.2 - 1.0

scpcli configinspection ci result list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--account_id <value>]
[--diagnosis_id <value>]
[--diagnosis_name <value>]
[--start_date <value>]
[--end_date <value>]
[--csp_type <value>]
[--diagnosis_state <value>]
[--user_id <value>]

Description

get Diagnosis Result List

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260531

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
account_id
optional
stringaccount Id0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_id
optional
stringId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name
optional
stringName of diagnosisSample Diagnosis Name
start_date
optional
stringstart Date2022-01-01
end_date
optional
stringend Date2022-12-31
csp_type
optional
stringType of cloud service providerSCP
diagnosis_state
optional
stringStatus of diagnosisCompleted
user_id
optional
stringuser Id76b563a009584b1380715c00703a02ff

Responses

NameDescriptionExample
count_checkcheck count10
count_errorerror count0
count_failfail count3
count_nana count2
count_passpass count5
csp_typeType of cloud service providerSCP
diagnosis_account_idId of diagnosis0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_typeCheck type of diagnosisBP
diagnosis_idId of diagnosisDIA-943731CB8E3045C289BAECAEC3532097
diagnosis_nameName of diagnosisSample Diagnosis Name
diagnosis_request_sequenceSequence of diagnosis request1234567890
diagnosis_resultdiagnosis ResultSUCCESS
diagnosis_total_countdiagnosis Total Count10
proceed_dateproceed Date2022-01-01T12:00:00Z
totaltotal count10

3 - Key Management Service

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Key Management Service(KMS) and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20260831
1.0DEPRECATED20251231

3.1 - CLIs

3.1.1 - Change Rotate Info

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integerRotation cycle7
auto_rotate
required
stringAuto rotate Y or NY

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integerRotation cycle7
auto_rotate
required
stringAuto rotate Y or NY

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
rotate_cycle
required
integerRotation cycle7
auto_rotate
required
stringAuto rotate Y or NY

3.1.2 - Change State Of Key

3.1.2.1 - 1.2

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

Description

Change state of key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
state
required
stringState of key(Active, Stop)Active

3.1.2.2 - 1.1

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

Description

Change state of key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
state
required
stringState of key(Active, Stop)Active

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
state
required
stringState of key(Active, Stop)Active

3.1.3 - Check Duplicate Name

3.1.3.1 - 1.2

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

Description

Check duplication of key name.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringName of keytestkey

Responses

NameDescriptionExample
isDuplicateNameTrue

3.1.3.2 - 1.1

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

Description

Check duplication of key name.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
name
required
stringName of keytestkey

Responses

NameDescriptionExample
isDuplicateNameTrue

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringName of keytestkey

Responses

NameDescriptionExample
isDuplicateNameTrue

3.1.4 - Create Datakey

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertextEncrypted data keyvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1
plaintextData key(base64 encoded)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertextEncrypted data keyvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1
plaintextData key(base64 encoded)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
key_type
required
stringKey type( plaintext or wrapped )plaintext

Responses

NameDescriptionExample
ciphertextEncrypted data keyvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1
plaintextData key(base64 encoded)oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

3.1.5 - Create Key

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integerRotation cycle7
purpose
required
stringPurpose of keyrsa-2048
name
required
stringName of keytestkey
description
required
stringDescription of Keydescription1
auto_rotate
required
stringAuto rotate Y or NY
key_type
optional
stringbasic or advancedadvanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
managed_typescp or useruser
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integerRotation cycle7
purpose
required
stringPurpose of keyrsa-2048
name
required
stringName of keytestkey
description
required
stringDescription of Keydescription1
auto_rotate
required
stringAuto rotate Y or NY
key_type
optional
stringbasic or advancedadvanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
rotate_cycle
required
integerRotation cycle7
purpose
required
stringPurpose of keyrsa-2048
name
required
stringName of keytestkey
description
required
stringDescription of Keydescription1
auto_rotate
required
stringAuto rotate Y or NY
key_type
optional
stringbasic or advancedadvanced
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.6 - Decrypt Data

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintextDecrypted data(base64 encoded)dGhlIHF1aWNrIGJyb3duIGZveAo=

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintextDecrypted data(base64 encoded)dGhlIHF1aWNrIGJyb3duIGZveAo=

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
plaintextDecrypted data(base64 encoded)dGhlIHF1aWNrIGJyb3duIGZveAo=

3.1.7 - Delete Key

3.1.7.1 - 1.2

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

Description

Delete a key now or later.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
booleanDelete immediatelyTrue

3.1.7.2 - 1.1

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

Description

Delete a key now or later.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
booleanDelete immediatelyTrue

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
is_directly
optional
booleanDelete immediatelyTrue

3.1.8 - Encrypt Data

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
plaintext
required
stringData(base64 encoded) to encryptdGhlIHF1aWNrIGJyb3duIGZveAo=

Responses

NameDescriptionExample
ciphertextEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.1.9 - List Keys

3.1.9.1 - 1.2

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

Description

List keys.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
managed_typescp or useruser
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.9.2 - 1.1

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

Description

List keys.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.10 - List Managed Keys

3.1.10.1 - 1.2

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

Description

List keys.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringName of keytestkey

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
managed_typescp or useruser
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.11 - List Users

3.1.11.1 - 1.2

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
user_nameUser Namekimsamsung

3.1.11.2 - 1.1

scpcli kms kms list users
--key_id <value>

Description

Get List of users who use key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
user_nameUser Namekimsamsung

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
user_idUser ID138c2fc8c29a449dbfa8681f8f1d78e2
user_nameUser Namekimsamsung

3.1.12 - Make hmac

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC datavault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC datavault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
hmacHMAC datavault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

3.1.13 - Rewrap Data

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextRewrapped data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextRewrapped data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
ciphertext
required
stringEncrypted data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK

Responses

NameDescriptionExample
ciphertextRewrapped data by KMSvault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_versionVersion of KMS key1

3.1.14 - Rotate Key

3.1.14.1 - 1.2

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.14.2 - 1.1

scpcli kms kms rotate
--key_id <value>

Description

Rotate key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.15 - Show Key

3.1.15.1 - 1.2

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
managed_typescp or useruser
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.15.2 - 1.1

scpcli kms kms show
--key_id <value>

Description

Show key.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.16 - Show Managed Key

3.1.16.1 - 1.2

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

Description

Show key.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
auto_rotateAuto rotate Y or NY
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_versionCurrent version of KMS key7
delete_atDate of deletion20251008
delete_target_ynDeleteTargetYn of KeyY
descriptionDescription of Keydescription1
key_typebasic or advancedadvanced
managed_typescp or useruser
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keytestkey
next_rotate_atDate of next rotate20241008
order_refReference of order0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purposePurpose of keyrsa-2048
regionName of regionkr-west1
rotate_cycleRotation cycle7
secret_refReference of secret0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
use_countUse count of KMS key1004

3.1.17 - Sign Data

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionVersion of KMS key1
signatureSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionVersion of KMS key1
signatureSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for SignaturedGVzdCBpbnB1dA==

Responses

NameDescriptionExample
key_versionVersion of KMS key1
signatureSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

3.1.18 - Update Description

3.1.18.1 - 1.2

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

Description

Update description.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Key-

3.1.18.2 - 1.1

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

Description

Update description.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Key-

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Key-

3.1.19 - Update Managed Key Description

3.1.19.1 - 1.2

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

Description

Update description.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
description
required
stringDescription of Keydescription1

3.1.20 - Verify Data

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
validVerify resultTrue

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
validVerify resultTrue

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
signature
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==

Responses

NameDescriptionExample
validVerify resultTrue

3.1.21 - Verify hmac with input

3.1.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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
validVerify resultTrue

3.1.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)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
validVerify resultTrue

3.1.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.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
key_id
required
stringResource id of KMS key138c2fc8c29a449dbfa8681f8f1d78e2
input
required
stringData(base64 encoded) for verificationdGVzdCBpbnB1dA==
hmac
required
stringSignature datavault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

Responses

NameDescriptionExample
validVerify resultTrue

4 - Secret Vault

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Secret Vault and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.0CURRENT-

4.1 - CLIs

4.1.1 - Create Secret Vault

4.1.1.1 - 1.0

scpcli secretvault sv create
--vault_token_ttl_ndays <value>
--temporary_key_ttl_nhours <value>
--name <value>
--acl_cidr <value>
--access_key_id <value>
[--description <value>]
[--tags <value>]

Description

Create Secret Vault.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
vault_token_ttl_ndays
required
integerTTL of vault token720
temporary_key_ttl_nhours
required
integerTemporary key valid hours3
name
required
stringSecret Vault Idname
acl_cidr
required
stringAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
access_key_id
required
stringId of access keyb754b12b39da4ce29a40c5e324650bd0
description
optional
stringDescriptiondescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

4.1.2 - Delete Secret Vault

4.1.2.1 - 1.0

scpcli secretvault sv delete
--secret_vault_id <value>
--waiting_time_ndays <value>

Description

Change Secret Vault state to ‘To be terminated’.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

4.1.3 - List Secret Vaults

4.1.3.1 - 1.0

scpcli secretvault sv list

Description

List Secret Vaults.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault token[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==
vault_token_secret_valueSecret of vault token[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

4.1.4 - Show Secret Vault

4.1.4.1 - 1.0

scpcli secretvault sv show
--secret_vault_id <value>

Description

Show Secret Vault.

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_keyAccess key[‘0e3*****************************’]
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access key[‘Temporary’, ‘Permanent’]
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of Keydescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of key[‘vaultkey’]
temp_key_expired_atTemporary key expired date2025-02-25 03:07:17.000
temporary_key_ttl_nhoursTemporary key valid hours[‘36’]
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token[‘10’]
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault key[‘SCP Open API Key’]
waiting_time_ndaysDays remaining until deletion10

5 - Secrets Manager

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Secrets Manager and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20260831

5.1 - CLIs

5.1.1 - Create Secret

5.1.1.1 - 1.1

scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
[--tags <value>]

Description

Create secret.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}
name
required
stringSecret Namename
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
description
optional
stringDescription of secretdescription
private_acl_enabled
optional
booleanEnable private access controltrue
private_acl_resources
optional
arrayPrivate access control resources'{"resource_id": ""}'
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
private_acl_enabledEnable private access controltrue
private_acl_resourcesPrivate access control resources
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.1.2 - 1.0

scpcli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
--acl_cidr <value>
[--description <value>]
[--tags <value>]

Description

Create secret.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}
name
required
stringSecret Namename
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
description
optional
stringDescription of secretdescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.2 - Delete Secret

5.1.2.1 - 1.1

scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>

Description

Delete secret.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

5.1.2.2 - 1.0

scpcli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>

Description

Delete secret.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

5.1.3 - Generate Random Password

5.1.3.1 - 1.1

scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]

Description

Generate random password.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
exclude_characters
optional
stringCharacters to exclude when generating passwordabcdefg
exclude_lowercase
optional
booleanOption to exclude lowercase lettersfalse
exclude_numbers
optional
booleanOption to exclude numbersfalse
exclude_punctuation
optional
booleanOption to exclude punctuationfalse
exclude_uppercase
optional
booleanOption to exclude uppercase lettersfalse
include_space
optional
booleanOption to include spacesfalse
password_length
optional
integerLength of the password to generate32
require_each_included_type
optional
booleanRequire all included character typestrue

Responses

NameDescriptionExample
random_passwordGenerate random password.random-value

5.1.3.2 - 1.0

scpcli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]

Description

Generate random password.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
exclude_characters
optional
stringCharacters to exclude when generating passwordabcdefg
exclude_lowercase
optional
booleanOption to exclude lowercase lettersfalse
exclude_numbers
optional
booleanOption to exclude numbersfalse
exclude_punctuation
optional
booleanOption to exclude punctuationfalse
exclude_uppercase
optional
booleanOption to exclude uppercase lettersfalse
include_space
optional
booleanOption to include spacesfalse
password_length
optional
integerLength of the password to generate32
require_each_included_type
optional
booleanRequire all included character typestrue

Responses

NameDescriptionExample
random_passwordGenerate random password.random-value

5.1.4 - List Secrets

5.1.4.1 - 1.1

scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]

Description

List secrets.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringSecret Namename
state
optional
arraySecret StateA

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.4.2 - 1.0

scpcli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]

Description

List secrets.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringSecret Namename
state
optional
arraySecret StateA

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.5 - List Versions of Secret

5.1.5.1 - 1.1

scpcli secretsmanager secret list version
--secret_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

List versions of secrets.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
size
optional
integersize100
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
countcount20
pagepage0
sizesize20
sortsort[‘created_at:asc’]
version_list

5.1.5.2 - 1.0

scpcli secretsmanager secret list version
--secret_id <value>

Description

List versions of secrets.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
version_list

5.1.6 - Restore Secret

5.1.6.1 - 1.1

scpcli secretsmanager secret restore
--secret_id <value>

Description

Cancel process of deleting secret.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

5.1.6.2 - 1.0

scpcli secretsmanager secret restore
--secret_id <value>

Description

Cancel process of deleting secret.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

5.1.7 - Set CIDR of Secret

5.1.7.1 - 1.1

scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>

Description

Edit the IP CIDR value for access control when retrieving the value of a Secret.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16

5.1.7.2 - 1.0

scpcli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>

Description

Edit the IP CIDR value for access control when retrieving the value of a Secret.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
acl_cidr
required
stringAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16

5.1.8 - Set Description of Secret

5.1.8.1 - 1.1

scpcli secretsmanager secret set description
--secret_id <value>
--description <value>

Description

Set description of secret.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
description
required
stringDescription of secretdescription

5.1.8.2 - 1.0

scpcli secretsmanager secret set description
--secret_id <value>
--description <value>

Description

Set description of secret.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
description
required
stringDescription of secretdescription

5.1.9 - Set KMS ID of Secret

5.1.9.1 - 1.1

scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>

Description

Modify the KMS ID used to encrypt the secret value.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c

5.1.9.2 - 1.0

scpcli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>

Description

Modify the KMS ID used to encrypt the secret value.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
kms_id
required
stringResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c

5.1.10 - Set Label of Version

5.1.10.1 - 1.1

scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]

Description

Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
required
stringLabel of secret version. Not allow duplication.My Custom Label
move_to_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c

5.1.10.2 - 1.0

scpcli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]

Description

Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
required
stringLabel of secret version. Not allow duplication.My Custom Label
move_to_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c
remove_from_version_id
optional
stringSecret Version ID3265ab469f0d406d83073da3e11e7a6c

5.1.11 - Set Private Acl of Secret

5.1.11.1 - 1.1

scpcli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]

Description

Update private acl.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
private_acl_enabled
optional
booleanEnable private access controltrue
private_acl_resources
optional
arrayPrivate access control resources'{"resource_id": ""}'

5.1.11.2 - 1.0

scpcli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]

Description

Update private acl.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
private_acl_enabled
optional
booleanEnable private access controltrue
private_acl_resources
optional
arrayPrivate access control resources'{"resource_id": ""}'

5.1.12 - Show Secret Detail

5.1.12.1 - 1.1

scpcli secretsmanager secret show
--secret_id <value>

Description

Show secret detail.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
offeringName of offering
private_acl_enabledEnable private access controltrue
private_acl_resourcesPrivate access control resources
recent_searched_atDate of recent search2025-02-25 03:07:17.000
regionName of region
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.12.2 - 1.0

scpcli secretsmanager secret show
--secret_id <value>

Description

Show secret detail.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list of secret in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
deleted_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of secretdescription
kms_idResource ID created in the Key Management Service (KMS) product3265ab469f0d406d83073da3e11e7a6c
kms_nameResource name of KMS keykmsname
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keymy-secret-name
recent_searched_atDate of recent search2025-02-25 03:07:17.000
stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
typeType of secretGeneral

5.1.13 - Show Secret Value

5.1.13.1 - 1.1

scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]

Description

Show secret value.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
optional
stringLabel of secret version. Not allow duplication.CURRENT
version_id
optional
stringSecret Version IDe7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{“key1”:“value1”,“key2”:“value2”}

5.1.13.2 - 1.0

scpcli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]

Description

Show secret value.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
label
optional
stringLabel of secret version. Not allow duplication.CURRENT
version_id
optional
stringSecret Version IDe7b638507d9f4feeb6032a22b7640bf7

Responses

NameDescriptionExample
secret_valueThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{“key1”:“value1”,“key2”:“value2”}

5.1.14 - Update Secret Value

5.1.14.1 - 1.1

scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>

Description

Update secret value.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}

5.1.14.2 - 1.0

scpcli secretsmanager secret update value
--secret_id <value>
--secret_value <value>

Description

Update secret value.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020260831

Parameters

NameTypeDescriptionExample
secret_id
required
stringSecret ID3265ab469f0d406d83073da3e11e7a6c
secret_value
required
stringThe value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.{"key1":"value1","key2":"value2"}