이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Security

1: Certificate Manager

1.1: CLIs

1.1.1: Check duplicate name

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: Create a certificate

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: Delete a certificate

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: Detail a certificate

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: List certificates

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: Self-sign a certificate

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: Validate a certificate

1.1.7.1: 1.1
1.1.7.2: 1.0

2: Config Inspection

2.1: CLIs

2.1.1: Create Config Inspection

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: Delete Config Inspection

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: Diagnosis Request

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: Get Diagnosis Object Detail

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Get Diagnosis Result Detail

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: List Config Inspection

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: List Diagnosis Result

2.1.7.1: 1.1
2.1.7.2: 1.0

3: Key Management Service

3.1: CLIs

3.1.1: Change Rotate Info

3.1.1.1: 1.1
3.1.1.2: 1.0

3.1.2: Change State Of Key

3.1.2.1: 1.1
3.1.2.2: 1.0

3.1.3: Check Duplicate Name

3.1.3.1: 1.1
3.1.3.2: 1.0

3.1.4: Create Datakey

3.1.4.1: 1.1
3.1.4.2: 1.0

3.1.5: Create Key

3.1.5.1: 1.1
3.1.5.2: 1.0

3.1.6: Decrypt Data

3.1.6.1: 1.1
3.1.6.2: 1.0

3.1.7: Delete Key

3.1.7.1: 1.1
3.1.7.2: 1.0

3.1.8: Encrypt Data

3.1.8.1: 1.1
3.1.8.2: 1.0

3.1.9: List Keys

3.1.9.1: 1.1
3.1.9.2: 1.0

3.1.10: List Users

3.1.10.1: 1.1
3.1.10.2: 1.0

3.1.11: Make hmac

3.1.11.1: 1.1
3.1.11.2: 1.0

3.1.12: Rewrap Data

3.1.12.1: 1.1
3.1.12.2: 1.0

3.1.13: Rotate Key

3.1.13.1: 1.1
3.1.13.2: 1.0

3.1.14: Show Key

3.1.14.1: 1.1
3.1.14.2: 1.0

3.1.15: Sign Data

3.1.15.1: 1.1
3.1.15.2: 1.0

3.1.16: Update Description

3.1.16.1: 1.1
3.1.16.2: 1.0

3.1.17: Verify Data

3.1.17.1: 1.1
3.1.17.2: 1.0

3.1.18: Verify hmac with input

3.1.18.1: 1.1
3.1.18.2: 1.0

4: Secret Vault

4.1: CLIs

4.1.1: Create Secret Vault

4.1.1.1: 1.0

4.1.2: Delete Secret Vault

4.1.2.1: 1.0

4.1.3: List Secret Vaults

4.1.3.1: 1.0

4.1.4: Show Secret Vault

4.1.4.1: 1.0

5: Secrets Manager

5.1: CLIs

5.1.1: Create Secret

5.1.1.1: 1.0

5.1.2: Delete Secret

5.1.2.1: 1.0

5.1.3: Generate Random Password

5.1.3.1: 1.0

5.1.4: List Secrets

5.1.4.1: 1.0

5.1.5: List Versions of Secret

5.1.5.1: 1.0

5.1.6: Restore Secret

5.1.6.1: 1.0

5.1.7: Set CIDR of Secret

5.1.7.1: 1.0

5.1.8: Set Description of Secret

5.1.8.1: 1.0

5.1.9: Set KMS ID of Secret

5.1.9.1: 1.0

5.1.10: Set Label of Version

5.1.10.1: 1.0

5.1.11: Show Secret Detail

5.1.11.1: 1.0

5.1.12: Show Secret Value

5.1.12.1: 1.0

5.1.13: Update Secret Value

5.1.13.1: 1.0

1 - Certificate Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Certificate Manager 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260531
1.1	CURRENT	-

1.1 - CLIs

1.1.1 - Check duplicate name

1.1.1.1 - 1.1

scpcli certificatemanager certificate check
--name <value>

Description

인증서 이름 중복 여부

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
name required	string	인증서 이름	-

Responses

Name	Description	Example
result	True, False 체크	True

1.1.1.2 - 1.0

scpcli certificatemanager certificate check
--name <value>

Description

인증서 이름 중복 여부

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
name required	string	인증서 이름	-

Responses

Name	Description	Example
result	True, False 체크	True

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

인증서 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
timezone required	string	타임존	`Asia/Seoul`
region required	string	리즌 이름	`west1`
private_key required	string	개인키	`<encoded private key data>`
name required	string	인증서 이름	`test-certificate`
cert_body required	string	인증서 body	`<encoded certificate body data>`
cert_chain optional	string	인증서 체인	`<encoded certificate chain data>`
recipients optional	array	만료된 인증서 수신인	`'{"region": "", "user_id": "", "user_name": ""}'`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	PRD
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
recipients	만료된 인증서 수신인	[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
state	인증서 상태	VALID
tags	태그 리스트
user_name	사용자 이름	kildong@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

인증서 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
timezone required	string	타임존	`Asia/Seoul`
region required	string	리즌 이름	`west1`
private_key required	string	개인키	`<encoded private key data>`
name required	string	인증서 이름	`test-certificate`
cert_body required	string	인증서 body	`<encoded certificate body data>`
cert_chain optional	string	인증서 체인	`<encoded certificate chain data>`
recipients optional	array	만료된 인증서 수신인	`'{"region": "", "user_id": "", "user_name": ""}'`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	PRD
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
recipients	만료된 인증서 수신인	[{‘region’: ‘’, ‘user_id’: ‘sdaFDQSDADZ2488e195c0e97d9b9eb’, ‘user_name’: ‘kildong.hong’}]
state	인증서 상태	VALID
tags	태그 리스트
user_name	사용자 이름	kildong@samsung.com

1.1.3 - Delete a certificate

1.1.3.1 - 1.1

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

인증서 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
certificate_id required	string	인증서 id	-

1.1.3.2 - 1.0

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

인증서 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
certificate_id required	string	인증서 id	-

1.1.4 - Detail a certificate

1.1.4.1 - 1.1

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

인증서 상세정보

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
certificate_id required	string	인증서 id	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	DEV
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
state	인증서 상태	VALID
user_name	사용자 이름	2048

1.1.4.2 - 1.0

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

인증서 상세정보

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
certificate_id required	string	인증서 id	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	DEV
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
state	인증서 상태	VALID
user_name	사용자 이름	2048

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

인증서 리스트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
ismine optional	boolean	사용자가 등록한 인증서인지 확인 여부	-
name optional	string	인증서 이름	`test-certificate`
cn optional	string	인증서 CN 정보	`test.go.kr`
state optional	array	인증서 상태	`V`

Responses

Name	Description	Example
id	인증서 id
cert_kind	인증서 타입	PRD
cn	인증서 CN 정보	test.go.kr
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
state	인증서 상태	VALID

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

인증서 리스트

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
ismine optional	boolean	사용자가 등록한 인증서인지 확인 여부	-
name optional	string	인증서 이름	`test-certificate`
cn optional	string	인증서 CN 정보	`test.go.kr`
state optional	array	인증서 상태	`V`

Responses

Name	Description	Example
id	인증서 id
cert_kind	인증서 타입	PRD
cn	인증서 CN 정보	test.go.kr
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
state	인증서 상태	VALID

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

인증서 자체 서명

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
timezone required	string	타임존	`Asia/Seoul`
region required	string	리즌 이름	`west1`
organization required	string	인증서 O(조직) 정보	`samsungSDS`
not_before_dt required	string	인증서 시작일	`20250101`
not_after_dt required	string	인증서 만료일	`20251212`
name required	string	인증서 이름	`test-certificate`
cn required	string	인증서 CN 정보	`test.go.kr`
recipients optional	array	만료된 인증서 수신인	`'{"region": "", "user_id": "", "user_name": ""}'`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	DEV
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
state	인증서 상태	VALID
user_name	사용자 이름	2048

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

인증서 자체 서명

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
timezone required	string	타임존	`Asia/Seoul`
region required	string	리즌 이름	`west1`
organization required	string	인증서 O(조직) 정보	`samsungSDS`
not_before_dt required	string	인증서 시작일	`20250101`
not_after_dt required	string	인증서 만료일	`20251212`
name required	string	인증서 이름	`test-certificate`
cn required	string	인증서 CN 정보	`test.go.kr`
recipients optional	array	만료된 인증서 수신인	`'{"region": "", "user_id": "", "user_name": ""}'`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	b82909b3576449fda984fb25c3123542da
cert_body	인증서 body
cert_chain	인증서 체인
cert_kind	인증서 타입	DEV
cert_type	인증서 타입	pem
cert_version	인증서 버전	2
cn	인증서 CN 정보	test.go.kr
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
key_bit_size	키 bit 크기	2048
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	인증서 이름	test-certificate
not_after_dt	인증서 만료일	2026-02-07T18:07:59
not_before_dt	인증서 시작일	2025-02-08T18:07:00
organization	인증서 O(조직) 정보	samsungSDS
private_key	개인키
state	인증서 상태	VALID
user_name	사용자 이름	2048

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

인증서 검증

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
private_key required	string	개인키	`<encoded private key data>`
cert_body required	string	인증서 body	`<encoded certificate body data>`
cert_chain optional	string	인증서 체인	`<encoded certificate chain data>`

Responses

Name	Description	Example
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

인증서 검증

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
private_key required	string	개인키	`<encoded private key data>`
is_need_cert_chain required	boolean	인증서 체인 필요 여부	`True`
cert_body required	string	인증서 body	`<encoded certificate body data>`
cert_chain optional	string	인증서 체인	`<encoded certificate chain data>`

Responses

Name	Description	Example
result	True, False 체크	True

2 - Config Inspection

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Config Inspection에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260531
1.1	CURRENT	-

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

진단 상품 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
use_diagnosis_check_type_ssi required	string	체크리스트 SSI 사용 여부	`y`
use_diagnosis_check_type_bp required	string	체크리스트 Best Practice 사용 여부	`y`
frequency_value required	string	Schedule value (01~31, MONDAY~SUNDAY, everyDay)	`1`
frequency_type required	string	Schedule type( monthly, weekly, daily)	`MONTH`
diagnosis_start_time_pattern required	string	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )	`08:00`
auth_key_id required	string	인증키 ID	`9b72a9856e494e67afc69atd3631fe38`
plan_type required	string	요금제	`STANDARD`
diagnosis_type required	string	진단 유형	`Console`
diagnosis_name required	string	진단명	`Sample Diagnosis Name`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_check_type required	string	진단 체크리스트	`BP`
diagnosis_account_id required	string	진단 ID	`0e3dffc50eb247a1adf4f2e5c82c4f99`
csp_type required	string	클라우드 서비스 제공자의 유형	`SCP`
account_id required	string	진단 계정	`0e3dffc50eb247a1adf4f2e5c82c4f99`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
auth_key_created_at optional	string	인증 키 생성 날짜	`2022-01-01 12:00:00`
auth_key_expired_at optional	string	인증 키 만료 날짜	`2023-01-01 12:00:00`

Responses

Name	Description	Example
diagnosis_id	진단 ID	Sample Diagnosis Name
result	True, False 체크	True

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

진단 상품 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
use_diagnosis_check_type_ssi required	string	체크리스트 SSI 사용 여부	`y`
use_diagnosis_check_type_bp required	string	체크리스트 Best Practice 사용 여부	`y`
frequency_value required	string	Schedule value (01~31, MONDAY~SUNDAY, everyDay)	`1`
frequency_type required	string	Schedule type( monthly, weekly, daily)	`MONTH`
diagnosis_start_time_pattern required	string	Start time( 5-minute increments, 00 to 23 hours, 00 to 55 minutes )	`08:00`
auth_key_id required	string	인증키 ID	`9b72a9856e494e67afc69atd3631fe38`
plan_type required	string	요금제	`STANDARD`
diagnosis_type required	string	진단 유형	`Console`
diagnosis_name required	string	진단명	`Sample Diagnosis Name`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_check_type required	string	진단 체크리스트	`BP`
diagnosis_account_id required	string	진단 ID	`0e3dffc50eb247a1adf4f2e5c82c4f99`
csp_type required	string	클라우드 서비스 제공자의 유형	`SCP`
account_id required	string	진단 계정	`0e3dffc50eb247a1adf4f2e5c82c4f99`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`
auth_key_created_at optional	string	인증 키 생성 날짜	`2022-01-01 12:00:00`
auth_key_expired_at optional	string	인증 키 만료 날짜	`2023-01-01 12:00:00`

Responses

Name	Description	Example
result	True, False 체크	True

2.1.2 - Delete Config Inspection

2.1.2.1 - 1.1

scpcli configinspection ci delete
--diagnosis_id <value>

Description

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
diagnosis_id required	string	진단 ID	`Sample Diagnosis Name`

2.1.2.2 - 1.0

scpcli configinspection ci delete
--diagnosis_id <value>

Description

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
diagnosis_id required	string	진단 ID	`Sample 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

진단 요청

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
tenant_id required	string	Tenant ID	`1234567890`
secret_key required	string	Secret Key	`SAMPLE KEY`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_check_type required	string	진단 체크리스트	`BP`
access_key required	string	Access Key	`SAMPLE KEY`

Responses

Name	Description	Example
result	True, False 체크	True

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

진단 요청

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
tenant_id required	string	Tenant ID	`1234567890`
secret_key required	string	Secret Key	`SAMPLE KEY`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_check_type required	string	진단 체크리스트	`BP`
access_key required	string	Access Key	`SAMPLE KEY`

Responses

Name	Description	Example
result	True, False 체크	True

2.1.4 - Get Diagnosis Object Detail

2.1.4.1 - 1.1

scpcli configinspection ci detail
--diagnosis_id <value>

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
diagnosis_id required	string	진단 ID	`Sample Diagnosis Name`

Responses

Name	Description	Example
auth_key_created_at	인증 키 생성 날짜	2022-01-01T12:00:00Z
auth_key_expired_at	인증 키 만료 날짜	2022-01-01T12:00:00Z
auth_key_id	인증키 ID	9b72a9856e494e67afc69atd3631fe38
auth_key_state	인증키 상태	ACTIVATED
user_id	사용자 ID	4f5d60e9e08b48d0a0881e21ab14e266

2.1.4.2 - 1.0

scpcli configinspection ci detail
--diagnosis_id <value>

Description

진단 결과 세부 정보 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
diagnosis_id required	string	진단 ID	`Sample Diagnosis Name`

Responses

Name	Description	Example
auth_key_created_at	인증 키 생성 날짜	2022-01-01T12:00:00Z
auth_key_expired_at	인증 키 만료 날짜	2022-01-01T12:00:00Z
auth_key_id	인증키 ID	9b72a9856e494e67afc69atd3631fe38
auth_key_state	인증키 상태	ACTIVATED
user_id	사용자 ID	4f5d60e9e08b48d0a0881e21ab14e266

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

진단 결과 세부 정보 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
diagnosis_request_sequence required	string	진단 요청 Sequence	`SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
action_guide	조치 가이드	원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changed	관리결과 변경 여부	True
diagnosis_check_type	진단 체크리스트	BP
diagnosis_criteria	진단 기준	【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_item	진단 항목	2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layer	영역	2.NETWORK
diagnosis_method	진단 방법	Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_result	확인결과 상태	03
result_contents	상세 결과	상세 내역
sub_category	Sub Category	NURIBP_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

진단 결과 세부 정보 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
diagnosis_request_sequence required	string	진단 요청 Sequence	`SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`
diagnosis_id required	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
action_guide	조치 가이드	원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.
changed	관리결과 변경 여부	True
diagnosis_check_type	진단 체크리스트	BP
diagnosis_criteria	진단 기준	【 Security Group 규칙 】
① 원격접속 Port에 Any IP 접근을 허용하는 규칙이 존재하지 않아야 합니다.
diagnosis_item	진단 항목	2.NW_003. 프로토콜 별 원격접속 Port는 접근이 필요한 IP를 지정하여 접속을 허용해야 합니다.
diagnosis_layer	영역	2.NETWORK
diagnosis_method	진단 방법	Security Group의 Inbound 규칙에 원격 접속이 필요한 사용자나 시스템만 접근을 허용하는 규칙을 등록 하였는지 확인합니다.
diagnosis_result	확인결과 상태	03
result_contents	상세 결과	상세 내역
sub_category	Sub Category	NURIBP_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

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
ismine optional	boolean	나의 Config Inspection	`False`
diagnosis_id optional	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_name optional	string	진단명	`My Diagnosis`
csp_type optional	string	클라우드 서비스 제공자의 유형	`SCP`
diagnosis_account_id optional	string	진단 ID	`0e3dffc50eb247a1adf4f2e5c82c4f99`
recent_diagnosis_state optional	array	최근 진단 상태	`C`
start_date optional	string	시작일	`2022-01-01 12:00:00`
end_date optional	string	종료일	`2022-01-02 12:00:00`

Responses

Name	Description	Example
created_at	생성일시	2022-01-01T12:00:00Z
csp_type	클라우드 서비스 제공자의 유형	SCP
diagnosis_account_id	진단 ID	0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type	진단 체크리스트	BP
diagnosis_id	진단 ID	DIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name	진단명	Sample Diagnosis Name
diagnosis_type	진단 유형	Console
error_state	최근 진단 오류 타입	CONNECTION_FAIL
plan_type	요금제	STANDARD
recent_diagnosis_at	최근 진단 일시	2022-01-01T12:00:00Z
recent_diagnosis_state	최근 진단 상태	Completed

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

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
ismine optional	boolean	나의 Config Inspection	`False`
diagnosis_id optional	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_name optional	string	진단명	`My Diagnosis`
csp_type optional	string	클라우드 서비스 제공자의 유형	`SCP`
diagnosis_account_id optional	string	진단 ID	`0e3dffc50eb247a1adf4f2e5c82c4f99`
recent_diagnosis_state optional	array	최근 진단 상태	`C`
start_date optional	string	시작일	`2022-01-01 12:00:00`
end_date optional	string	종료일	`2022-01-02 12:00:00`

Responses

Name	Description	Example
created_at	생성일시	2022-01-01T12:00:00Z
csp_type	클라우드 서비스 제공자의 유형	SCP
diagnosis_account_id	진단 ID	0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type	진단 체크리스트	BP
diagnosis_id	진단 ID	DIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name	진단명	Sample Diagnosis Name
diagnosis_type	진단 유형	Console
error_state	최근 진단 오류 타입	CONNECTION_FAIL
plan_type	요금제	STANDARD
recent_diagnosis_at	최근 진단 일시	2022-01-01T12:00:00Z
recent_diagnosis_state	최근 진단 상태	Completed

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

진단 결과 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	진단 계정	`0e3dffc50eb247a1adf4f2e5c82c4f99`
diagnosis_id optional	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_name optional	string	진단명	`Sample Diagnosis Name`
start_date optional	string	시작일	`2022-01-01`
end_date optional	string	종료일	`2022-12-31`
csp_type optional	string	클라우드 서비스 제공자의 유형	`SCP`
diagnosis_state optional	string	진단 상태	`Completed`
user_id optional	string	사용자 ID	`76b563a009584b1380715c00703a02ff`

Responses

Name	Description	Example
count_check	check 개수	10
count_error	error 개수	0
count_fail	fail 개수	3
count_na	na 개수	2
count_pass	pass 개수	5
csp_type	클라우드 서비스 제공자의 유형	SCP
diagnosis_account_id	진단 ID	0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type	진단 체크리스트	BP
diagnosis_id	진단 ID	DIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name	진단명	Sample Diagnosis Name
diagnosis_request_sequence	진단 요청 Sequence	1234567890
diagnosis_result	진단 결과	SUCCESS
diagnosis_total_count	총 개수	10
proceed_date	진단 일자	2022-01-01T12:00:00Z
total	전체 개수	10

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

진단 결과 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
account_id optional	string	진단 계정	`0e3dffc50eb247a1adf4f2e5c82c4f99`
diagnosis_id optional	string	진단 ID	`DIA-943731CB8E3045C289BAECAEC3532097`
diagnosis_name optional	string	진단명	`Sample Diagnosis Name`
start_date optional	string	시작일	`2022-01-01`
end_date optional	string	종료일	`2022-12-31`
csp_type optional	string	클라우드 서비스 제공자의 유형	`SCP`
diagnosis_state optional	string	진단 상태	`Completed`
user_id optional	string	사용자 ID	`76b563a009584b1380715c00703a02ff`

Responses

Name	Description	Example
count_check	check 개수	10
count_error	error 개수	0
count_fail	fail 개수	3
count_na	na 개수	2
count_pass	pass 개수	5
csp_type	클라우드 서비스 제공자의 유형	SCP
diagnosis_account_id	진단 ID	0e3dffc50eb247a1adf4f2e5c82c4f99
diagnosis_check_type	진단 체크리스트	BP
diagnosis_id	진단 ID	DIA-943731CB8E3045C289BAECAEC3532097
diagnosis_name	진단명	Sample Diagnosis Name
diagnosis_request_sequence	진단 요청 Sequence	1234567890
diagnosis_result	진단 결과	SUCCESS
diagnosis_total_count	총 개수	10
proceed_date	진단 일자	2022-01-01T12:00:00Z
total	전체 개수	10

3 - Key Management Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Key Management Service(KMS)에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

3.1 - CLIs

3.1.1 - Change Rotate Info

3.1.1.1 - 1.1

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

Description

키 회전정보를 변경한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
rotate_cycle required	integer	회전 주기	`7`
auto_rotate required	string	자동회전 Y 또는 N	`Y`

3.1.1.2 - 1.0

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

Description

키 회전정보를 변경한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
rotate_cycle required	integer	회전 주기	`7`
auto_rotate required	string	자동회전 Y 또는 N	`Y`

3.1.2 - Change State Of Key

3.1.2.1 - 1.1

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

Description

키 상태를 변경한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
state required	string	State of key(Active, Stop)	`Active`

3.1.2.2 - 1.0

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

Description

키 상태를 변경한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
state required	string	State of key(Active, Stop)	`Active`

3.1.3 - Check Duplicate Name

3.1.3.1 - 1.1

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

Description

키 이름 중복을 체크한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
name required	string	키 이름	`testkey`

Responses

Name	Description	Example
isDuplicateName		True

3.1.3.2 - 1.0

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

Description

키 이름 중복을 체크한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	키 이름	`testkey`

Responses

Name	Description	Example
isDuplicateName		True

3.1.4 - Create Datakey

3.1.4.1 - 1.1

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

Description

새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
key_type required	string	Key type( plaintext or wrapped )	`plaintext`

Responses

Name	Description	Example
ciphertext	암호화된 데이터 키	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1
plaintext	데이터키 (base64로 인코딩된)	oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

3.1.4.2 - 1.0

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

Description

새 데이터키를 생성하고, 키(용도:암호화/복호화)로 암호화된 값을 생성합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
key_type required	string	Key type( plaintext or wrapped )	`plaintext`

Responses

Name	Description	Example
ciphertext	암호화된 데이터 키	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1
plaintext	데이터키 (base64로 인코딩된)	oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=

3.1.5 - Create Key

3.1.5.1 - 1.1

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

Description

키를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
rotate_cycle required	integer	회전 주기	`7`
purpose required	string	키 용도	`rsa-2048`
name required	string	키 이름	`testkey`
description required	string	키 설명	`description1`
auto_rotate required	string	자동회전 Y 또는 N	`Y`
key_type optional	string	기본 또는 고급	`advanced`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.5.2 - 1.0

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

Description

키를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
rotate_cycle required	integer	회전 주기	`7`
purpose required	string	키 용도	`rsa-2048`
name required	string	키 이름	`testkey`
description required	string	키 설명	`description1`
auto_rotate required	string	자동회전 Y 또는 N	`Y`
key_type optional	string	기본 또는 고급	`advanced`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.6 - Decrypt Data

3.1.6.1 - 1.1

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

Description

키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
ciphertext required	string	KMS에 의해 암호화된 데이터	`vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
plaintext	데이터키 (base64로 인코딩된 )	dGhlIHF1aWNrIGJyb3duIGZveAo=

3.1.6.2 - 1.0

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

Description

키(용도:암호화/복호화)를 사용하여 제공된 암호문을 해독합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
ciphertext required	string	KMS에 의해 암호화된 데이터	`vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
plaintext	데이터키 (base64로 인코딩된 )	dGhlIHF1aWNrIGJyb3duIGZveAo=

3.1.7 - Delete Key

3.1.7.1 - 1.1

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

Description

키를 지금 또는 나중에 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
is_directly optional	boolean	즉시삭제 여부	`True`

3.1.7.2 - 1.0

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

Description

키를 지금 또는 나중에 삭제한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
is_directly optional	boolean	즉시삭제 여부	`True`

3.1.8 - Encrypt Data

3.1.8.1 - 1.1

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

Description

제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
plaintext required	string	Data(base64 encoded) to encrypt	`dGhlIHF1aWNrIGJyb3duIGZveAo=`

Responses

Name	Description	Example
ciphertext	KMS에 의해 암호화된 데이터	vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1

3.1.8.2 - 1.0

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

Description

제공된 일반 텍스트(base64 인코딩)를 키(용도:암호화/복호화)를 사용하여 암호화합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
plaintext required	string	Data(base64 encoded) to encrypt	`dGhlIHF1aWNrIGJyb3duIGZveAo=`

Responses

Name	Description	Example
ciphertext	KMS에 의해 암호화된 데이터	vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1

3.1.9 - List Keys

3.1.9.1 - 1.1

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

Description

키 리스트 조회하기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	키 이름	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.9.2 - 1.0

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

Description

키 리스트 조회하기

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	키 이름	`testkey`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.10 - List Users

3.1.10.1 - 1.1

scpcli kms kms list users
--key_id <value>

Description

키를 사용한 사람 목록을 보여준다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
user_id	사용자 id	138c2fc8c29a449dbfa8681f8f1d78e2
user_name	사용자 이름	kimsamsung

3.1.10.2 - 1.0

scpcli kms kms list users
--key_id <value>

Description

키를 사용한 사람 목록을 보여준다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
user_id	사용자 id	138c2fc8c29a449dbfa8681f8f1d78e2
user_name	사용자 이름	kimsamsung

3.1.11 - Make hmac

3.1.11.1 - 1.1

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

Description

HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
hmac	HMAC 데이터	vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

3.1.11.2 - 1.0

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

Description

HMAC 키를 사용해 생성합니다.( 용도: 생성/확인 )

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
hmac	HMAC 데이터	vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ=

3.1.12 - Rewrap Data

3.1.12.1 - 1.1

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

Description

최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
ciphertext required	string	KMS에 의해 암호화된 데이터	`vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
ciphertext	KMS에 의해 암호화된 재래핑할 데이터	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1

3.1.12.2 - 1.0

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

Description

최신 버전의 키(용도:암호화/복호화)를 사용하여 제공된 암호문을 다시 래핑합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
ciphertext required	string	KMS에 의해 암호화된 데이터	`vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`

Responses

Name	Description	Example
ciphertext	KMS에 의해 암호화된 재래핑할 데이터	vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK
key_version	KMS 키 버전	1

3.1.13 - Rotate Key

3.1.13.1 - 1.1

scpcli kms kms rotate
--key_id <value>

Description

키를 회전한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.13.2 - 1.0

scpcli kms kms rotate
--key_id <value>

Description

키를 회전한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.14 - Show Key

3.1.14.1 - 1.1

scpcli kms kms show
--key_id <value>

Description

키 정보를 보여준다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.14.2 - 1.0

scpcli kms kms show
--key_id <value>

Description

키 정보를 보여준다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
auto_rotate	자동회전 Y 또는 N	Y
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
current_version	KMS키 현재 버전	7
delete_at	Date of deletion	20251008
delete_target_yn	키 삭제예정 여부	Y
description	키 설명	description1
key_type	기본 또는 고급	advanced
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	testkey
next_rotate_at	다음 회전일	20241008
order_ref	오더 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
purpose	키 용도	rsa-2048
region	리즌 이름	kr-west1
rotate_cycle	회전 주기	7
secret_ref	시크릿 참조	0e1bfdf8-a7da-43d3-8e8c-c9f34024ba01
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
use_count	KMS키 사용횟수	1004

3.1.15 - Sign Data

3.1.15.1 - 1.1

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

Description

키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for Signature	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
key_version	KMS 키 버전	1
signature	확인을 위한 시그니쳐	vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

3.1.15.2 - 1.0

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

Description

키(용도:서명/검증)를 사용하여 주어진 데이터의 암호화 서명을 반환합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for Signature	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
key_version	KMS 키 버전	1
signature	확인을 위한 시그니쳐	vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=

3.1.16 - Update Description

3.1.16.1 - 1.1

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

Description

설명을 업데이트한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
description required	string	키 설명	-

3.1.16.2 - 1.0

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

Description

설명을 업데이트한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
description required	string	키 설명	-

3.1.17 - Verify Data

3.1.17.1 - 1.1

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

Description

제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
signature required	string	확인을 위한 시그니쳐	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
valid	확인결과	True

3.1.17.2 - 1.0

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

Description

제공된 서명이 서명 데이터 중 하나에서 지정된 데이터에 대해 유효한지 여부를 키(용도:서명/검증)를 사용해 반환합니다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
signature required	string	확인을 위한 시그니쳐	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`

Responses

Name	Description	Example
valid	확인결과	True

3.1.18 - Verify hmac with input

3.1.18.1 - 1.1

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

Description

INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`
hmac required	string	확인을 위한 시그니쳐	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`

Responses

Name	Description	Example
valid	확인결과	True

3.1.18.2 - 1.0

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

Description

INPUT이 유효한지 아닌지 키를 사용해 확인합니다(용도: 생성/확인)

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Name	Type	Description	Example
key_id required	string	KMS 키 자원 아이디	`138c2fc8c29a449dbfa8681f8f1d78e2`
input required	string	Data(base64 encoded) for verification	`dGVzdCBpbnB1dA==`
hmac required	string	확인을 위한 시그니쳐	`vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`

Responses

Name	Description	Example
valid	확인결과	True

4 - Secret Vault

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Secret Vault에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

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

시크릿볼트 생성.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
vault_token_ttl_ndays required	integer	볼트 토큰 유효시간	`720`
temporary_key_ttl_nhours required	integer	임시키 유효 시간	`3`
name required	string	시크릿볼트 아이디	`name`
acl_cidr required	string	접근제한을 위한 CIDR	`192.168.1.1/24, 10.0.0.1/16`
access_key_id required	string	Access key ID	`b754b12b39da4ce29a40c5e324650bd0`
description optional	string	Description	`description`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_id	Access key ID	0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_type	access key 유형	Temporary
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	접근제한을 위한 CIDR	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
delete_at	Date of deletion	2025-02-25 03:07:17.000
description	Description	description
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	vaultkey
temporary_key_ttl_nhours	임시키 유효 시간	36
user_name	사용자명	username
vault_token_expired_at	볼트 토큰 만료일	2025-02-25 03:07:17.000
vault_token_id	볼트토큰 아이디	aace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_value	볼트토큰 시크릿	6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndays	볼트 토큰 유효시간	10
vaultkey_state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
vaultkey_type	볼트키 타입	SCP Open API Key
waiting_time_ndays	삭제까지 남은 일수	10

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

시크릿볼트 상태는 To be terminated 가 아닙니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_vault_id required	string	시크릿볼트 아이디	`3265ab469f0d406d83073da3e11e7a6c`
waiting_time_ndays required	integer	삭제까지 남은 일수	`7`

4.1.3 - List Secret Vaults

4.1.3.1 - 1.0

scpcli secretvault sv list

Description

시크릿볼트 리스트 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_id	Access key ID	0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_type	access key 유형	Temporary
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	접근제한을 위한 CIDR	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
delete_at	Date of deletion	2025-02-25 03:07:17.000
description	Description	description
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	vaultkey
temporary_key_ttl_nhours	임시키 유효 시간	36
user_name	사용자명	username
vault_token_expired_at	볼트 토큰 만료일	2025-02-25 03:07:17.000
vault_token_id	볼트토큰 아이디	[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==
vault_token_secret_value	볼트토큰 시크릿	[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==
vault_token_ttl_ndays	볼트 토큰 유효시간	10
vaultkey_state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
vaultkey_type	볼트키 타입	SCP Open API Key
waiting_time_ndays	삭제까지 남은 일수	10

4.1.4 - Show Secret Vault

4.1.4.1 - 1.0

scpcli secretvault sv show
--secret_vault_id <value>

Description

시크릿볼트 조회.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_vault_id required	string	시크릿볼트 아이디	`3265ab469f0d406d83073da3e11e7a6c`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key	삼성 클라우드 플랫폼 포털에서 발급받은 Access Key	[‘0e3*****************************’]
access_key_id	Access key ID	0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_type	access key 유형	[‘Temporary’, ‘Permanent’]
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	접근제한을 위한 CIDR	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
delete_at	Date of deletion	2025-02-25 03:07:17.000
description	키 설명	description
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	[‘vaultkey’]
temp_key_expired_at	임시키 만료일	2025-02-25 03:07:17.000
temporary_key_ttl_nhours	임시키 유효 시간	[‘36’]
vault_token_expired_at	볼트 토큰 만료일	2025-02-25 03:07:17.000
vault_token_id	볼트토큰 아이디	aace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_value	볼트토큰 시크릿	6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndays	볼트 토큰 유효시간	[‘10’]
vaultkey_state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
vaultkey_type	볼트키 타입	[‘SCP Open API Key’]
waiting_time_ndays	삭제까지 남은 일수	10

5 - Secrets Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 Secrets Manager에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

5.1 - CLIs

5.1.1 - Create Secret

5.1.1.1 - 1.0

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

Description

Secret 을 생성합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_value required	string	The 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	string	Secret 이름	`name`
kms_id required	string	Resource ID created in the Key Management Service (KMS) product	`3265ab469f0d406d83073da3e11e7a6c`
acl_cidr required	string	Secret 접근허용 CIDR 리스트	`192.168.1.1/24, 10.0.0.1/16`
description optional	string	Secret 설명	`description`
tags optional	array	Tag List'	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	Secret 접근허용 CIDR 리스트	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
deleted_at	Date of deletion	2025-02-25 03:07:17.000
description	Secret 설명	description
kms_id	Key Management Service 상품에서 생성한 자원 ID	3265ab469f0d406d83073da3e11e7a6c
kms_name	KMS 키 이름	kmsname
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	my-secret-name
recent_searched_at	최근 검색일	2025-02-25 03:07:17.000
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
type	Secret 타입	General

5.1.2 - Delete Secret

5.1.2.1 - 1.0

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

Description

Secret을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
waiting_time_ndays required	integer	삭제까지 남은 일수	`7`

5.1.3 - Generate Random Password

5.1.3.1 - 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

임의 비밀번호 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
exclude_characters optional	string	비밀번호 생성 시 제외할 문자들	`abcdefg`
exclude_lowercase optional	boolean	소문자 제외 옵션	`false`
exclude_numbers optional	boolean	숫자 제외 옵션	`false`
exclude_punctuation optional	boolean	특수문자 제외 옵션	`false`
exclude_uppercase optional	boolean	대문자 제외 옵션	`false`
include_space optional	boolean	공백 포함 옵션	`false`
password_length optional	integer	생성할 비밀번호의 길이	`32`
require_each_included_type optional	boolean	포함된 모든 문자 유형 필수 요구	`true`

Responses

Name	Description	Example
random_password	임의 비밀번호 생성	random-value

5.1.4 - List Secrets

5.1.4.1 - 1.0

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

Description

Secret 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Secret 이름	`name`
state optional	array	Secret 상태	`A`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	Secret 접근허용 CIDR 리스트	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
deleted_at	Date of deletion	2025-02-25 03:07:17.000
description	Secret 설명	description
kms_id	Key Management Service 상품에서 생성한 자원 ID	3265ab469f0d406d83073da3e11e7a6c
kms_name	KMS 키 이름	kmsname
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	my-secret-name
recent_searched_at	최근 검색일	2025-02-25 03:07:17.000
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
type	Secret 타입	General

5.1.5 - List Versions of Secret

5.1.5.1 - 1.0

scpcli secretsmanager secret list version
--secret_id <value>

Description

Secrets 버전 리스트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`

Responses

Name	Description	Example
version_list

5.1.6 - Restore Secret

5.1.6.1 - 1.0

scpcli secretsmanager secret restore
--secret_id <value>

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`

5.1.7 - Set CIDR of Secret

5.1.7.1 - 1.0

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

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
acl_cidr required	string	Secret 접근허용 CIDR 리스트	`192.168.1.1/24, 10.0.0.1/16`

5.1.8 - Set Description of Secret

5.1.8.1 - 1.0

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

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
description required	string	Secret 설명	`description`

5.1.9 - Set KMS ID of Secret

5.1.9.1 - 1.0

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

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
kms_id required	string	Resource ID created in the Key Management Service (KMS) product	`3265ab469f0d406d83073da3e11e7a6c`

5.1.10 - Set Label of Version

5.1.10.1 - 1.0

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

Description

Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
label required	string	Secret 버전 라벨. 중복 불가.	`My Custom Label`
move_to_version_id optional	string	Secret 버전 아이디	`3265ab469f0d406d83073da3e11e7a6c`
remove_from_version_id optional	string	Secret 버전 아이디	`3265ab469f0d406d83073da3e11e7a6c`

5.1.11 - Show Secret Detail

5.1.11.1 - 1.0

scpcli secretsmanager secret show
--secret_id <value>

Description

Secret 상세정보 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
account_id	계정 id	3265ab469f0d406d83073da3e11e7a6c
acl_cidr	Secret 접근허용 CIDR 리스트	192.168.1.1/24, 10.0.0.1/16
created_at	생성 시간	2024-05-17T00:23:17Z
created_by	생성자	90dddfc2b1e04edba54ba2b41539a9ac
deleted_at	Date of deletion	2025-02-25 03:07:17.000
description	Secret 설명	description
kms_id	Key Management Service 상품에서 생성한 자원 ID	3265ab469f0d406d83073da3e11e7a6c
kms_name	KMS 키 이름	kmsname
modified_at	수정 시간	2024-05-17T00:23:17Z
modified_by	수정자	90dddfc2b1e04edba54ba2b41539a9ac
name	키 이름	my-secret-name
recent_searched_at	최근 검색일	2025-02-25 03:07:17.000
state	키 상태(Creating, Active, Error, Stop, To_Be_Terminated)	Active
type	Secret 타입	General

5.1.12 - Show Secret Value

5.1.12.1 - 1.0

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

Description

Secret value 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
label optional	string	Secret 버전 라벨. 중복 불가.	`CURRENT`
version_id optional	string	Secret 버전 아이디	`e7b638507d9f4feeb6032a22b7640bf7`

Responses

Name	Description	Example
secret_value	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다.	{“key1”:“value1”,“key2”:“value2”}

5.1.13 - Update Secret Value

5.1.13.1 - 1.0

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

Description

Secret value 업데이트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Name	Type	Description	Example
secret_id required	string	Secret 아이디	`3265ab469f0d406d83073da3e11e7a6c`
secret_value required	string	The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.	`{"key1":"value1","key2":"value2"}`