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

Security

1: Certificate Manager

1.1: APIs

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

1.2: Models

1.2.1: CertificateCreate
1.2.2: CertificateCreateRequest
1.2.3: CertificateCreateResponse
1.2.4: CertificateDetail
1.2.5: CertificateDetailResponse
1.2.6: CertificateDuplicateRequest
1.2.7: CertificateList
1.2.8: CertificateListResponse
1.2.9: CertificateValidateRequest
1.2.10: CertificateValidateRequestV1Dot1
1.2.11: CertificateValidateResponseV1Dot1
1.2.12: CheckResponse
1.2.13: Recipient
1.2.14: SelfSignCreateRequest
1.2.15: Tag

2: Config Inspection

2.1: APIs

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: Disgnosis Response

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Get Diagnosis Object Detail

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: Get Diagnosis Result Detail

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: List Config Inspection

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: List Diagnosis Result

2.1.8.1: 1.1
2.1.8.2: 1.0

2.2: Models

2.2.1: AuthKeyRequest
2.2.2: AuthKeyResponse
2.2.3: CheckResponse
2.2.4: ConfigInspectionCreateResponse
2.2.5: ConfigInspectionListResponse
2.2.6: ConfigInspectionLookinError
2.2.7: ConfigInspectionLookinResponse
2.2.8: ConfigInspectionLookinResult
2.2.9: ConfigInspectionLookinTarget
2.2.10: DiagnosisObjectDetailResponse
2.2.11: DiagnosisObjectRequest
2.2.12: DiagnosisRequest
2.2.13: DiagnosisResultDetail
2.2.14: DiagnosisResultDetailResponse
2.2.15: DiagnosisResultListResponse
2.2.16: DiagnosisResultResponse
2.2.17: DiagnosisScheduleRequest
2.2.18: DiagnosisScheduleResponse
2.2.19: SummaryResponse
2.2.20: Tag
2.2.21: TerminateResponse

3: Key Management Service

3.1: APIs

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

3.2: Models

3.2.1: DatakeyRequest
3.2.2: DatakeyResponse
3.2.3: DecryptRequest
3.2.4: DecryptResponse
3.2.5: EncryptRequest
3.2.6: EncryptResponse
3.2.7: HmacRequest
3.2.8: HmacResponse
3.2.9: HmacVerifyRequest
3.2.10: HmacVerifyResponse
3.2.11: Key
3.2.12: KeyCreateMasterKeyRequest
3.2.13: KeyDescriptionRequest
3.2.14: KeyNameDuplicateResponse
3.2.15: KeyPageResponse
3.2.16: KeyRotateInfoRequest
3.2.17: KeyShowResponse
3.2.18: KeyStateRequest
3.2.19: KeyUserResponse
3.2.20: RewrapRequest
3.2.21: RewrapResponse
3.2.22: SignRequest
3.2.23: SignResponse
3.2.24: Tag
3.2.25: User
3.2.26: VerifyRequest
3.2.27: VerifyResponse

4: Secret Vault

4.1: APIs

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: Get Temporary Key

4.1.3.1: 1.0

4.1.4: List Secret Vaults

4.1.4.1: 1.0

4.1.5: Show Secret Vault

4.1.5.1: 1.0

4.2: Models

4.2.1: SecretVaultCreateRequest
4.2.2: SecretVaultCreateResponse
4.2.3: SecretVaultDetailKey
4.2.4: SecretVaultKey
4.2.5: SecretVaultKeyListResponse
4.2.6: SecretVaultListKey
4.2.7: SecretVaultShowResponse
4.2.8: SecretVaultTemporaryKeyResponse
4.2.9: SecretVaultTerminatedRequest
4.2.10: Tag

5: Secrets Manager

5.1: APIs

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

5.2: Models

5.2.1: SecretsManager
5.2.2: SecretsManagerCreateRequest
5.2.3: SecretsManagerCreateResponse
5.2.4: SecretsManagerListResponse
5.2.5: SecretsManagerSetCidrRequest
5.2.6: SecretsManagerSetDescriptionRequest
5.2.7: SecretsManagerSetKmsRequest
5.2.8: SecretsManagerSetSecretValueRequest
5.2.9: SecretsManagerShowResponse
5.2.10: SecretsManagerShowSecretValueRequest
5.2.11: SecretsManagerShowSecretValueResponse
5.2.12: SecretsManagerTerminatedRequest
5.2.13: SecretsManagerUpdateLabelRequest
5.2.14: SecretsManagerVersionListResponse
5.2.15: SecretsRandomPasswordRequest
5.2.16: SecretsRandomPasswordResponse
5.2.17: Tag

1 - Certificate Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Certificate Manager 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260531
1.1	CURRENT	-

OpenAPI URL

https://certificatemanager.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1.1 - APIs

1.1.1 - Check duplicate name

1.1.1.1 - 1.1

post /v1/certificatemanager/check-duplication

Description

인증서 이름 중복 여부

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateDuplicateRequest

Responses

HTTP Code	Description	Schema
200	OK	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Request body

{
    "name": ""
}

Example HTTP response

Response 200

{
    "result": true
}

1.1.1.2 - 1.0

post /v1/certificatemanager/check-duplication

Description

인증서 이름 중복 여부

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateDuplicateRequest

Responses

HTTP Code	Description	Schema
200	OK	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Request body

{
    "name": ""
}

Example HTTP response

Response 200

{
    "result": true
}

1.1.2 - Create a certificate

1.1.2.1 - 1.1

post /v1/certificatemanager

Description

인증서 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	CertificateCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Request body

{
    "cert_body": "<encoded certificate body data>",
    "cert_chain": "<encoded certificate chain data>",
    "name": "test-certificate",
    "private_key": "<encoded private key data>",
    "recipients": [
        {
            "region": "",
            "user_id": "sdaFDQSDADZ2488e195c0e97d9b9eb",
            "user_name": "kildong.hong"
        }
    ],
    "region": "west1",
    "tags": [],
    "timezone": "Asia/Seoul"
}

Example HTTP response

Response 201

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "PRD",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "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

post /v1/certificatemanager

Description

인증서 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	CertificateCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Request body

{
    "cert_body": "<encoded certificate body data>",
    "cert_chain": "<encoded certificate chain data>",
    "name": "test-certificate",
    "private_key": "<encoded private key data>",
    "recipients": [
        {
            "region": "",
            "user_id": "sdaFDQSDADZ2488e195c0e97d9b9eb",
            "user_name": "kildong.hong"
        }
    ],
    "region": "west1",
    "tags": [],
    "timezone": "Asia/Seoul"
}

Example HTTP response

Response 201

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "PRD",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "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

delete /v1/certificatemanager/{certificate_id}

Description

인증서 삭제

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	certificate_id required	인증서 id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
204	No Content	None
403	Forbidden	None

Example HTTP request

Request path

/v1/certificatemanager/{certificate_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Example HTTP response

Response 200

1.1.3.2 - 1.0

delete /v1/certificatemanager/{certificate_id}

Description

인증서 삭제

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	certificate_id required	인증서 id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	None
204	No Content	None
403	Forbidden	None

Example HTTP request

Request path

/v1/certificatemanager/{certificate_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Example HTTP response

Response 200

1.1.4 - Detail a certificate

1.1.4.1 - 1.1

get /v1/certificatemanager/{certificate_id}

Description

인증서 상세정보

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	certificate_id required	인증서 id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	CertificateDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/{certificate_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "DEV",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "samsungSDS",
        "private_key": "",
        "state": "VALID",
        "user_name": "2048"
    }
}

1.1.4.2 - 1.0

get /v1/certificatemanager/{certificate_id}

Description

인증서 상세정보

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	certificate_id required	인증서 id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	CertificateDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/{certificate_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "DEV",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "samsungSDS",
        "private_key": "",
        "state": "VALID",
        "user_name": "2048"
    }
}

1.1.5 - List certificates

1.1.5.1 - 1.1

get /v1/certificatemanager

Description

인증서 리스트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	isMine optional	사용자가 등록한 인증서인지 확인 여부 Example : `False`	any of [boolean, null]	False
query	name optional	인증서 이름 Example : `test-certificate`	any of [string, null]	None
query	cn optional	인증서 CN 정보 Example : `test.go.kr`	any of [string, null]	None
query	state optional	인증서 상태 Example : `VALID`	any of [array[string], string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	CertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "PRD",
            "cn": "test.go.kr",
            "id": "",
            "name": "test-certificate",
            "not_after_dt": "2026-02-07T18:07:59",
            "not_before_dt": "2025-02-08T18:07:00",
            "state": "VALID"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.1.5.2 - 1.0

get /v1/certificatemanager

Description

인증서 리스트

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	isMine optional	사용자가 등록한 인증서인지 확인 여부 Example : `False`	any of [boolean, null]	False
query	name optional	인증서 이름 Example : `test-certificate`	any of [string, null]	None
query	cn optional	인증서 CN 정보 Example : `test.go.kr`	any of [string, null]	None
query	state optional	인증서 상태 Example : `VALID`	any of [array[string], string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	CertificateListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "PRD",
            "cn": "test.go.kr",
            "id": "",
            "name": "test-certificate",
            "not_after_dt": "2026-02-07T18:07:59",
            "not_before_dt": "2025-02-08T18:07:00",
            "state": "VALID"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.1.6 - Self-sign a certificate

1.1.6.1 - 1.1

post /v1/certificatemanager/self-sign

Description

인증서 자체 서명

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SelfSignCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	CertificateDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/self-sign

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Request body

{
    "cn": "test.go.kr",
    "name": "test-certificate",
    "not_after_dt": "20251212",
    "not_before_dt": "20250101",
    "organization": "samsungSDS",
    "recipients": [],
    "region": "west1",
    "tags": [],
    "timezone": "Asia/Seoul"
}

Example HTTP response

Response 201

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "DEV",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "samsungSDS",
        "private_key": "",
        "state": "VALID",
        "user_name": "2048"
    }
}

1.1.6.2 - 1.0

post /v1/certificatemanager/self-sign

Description

인증서 자체 서명

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		SelfSignCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	CertificateDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/self-sign

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Request body

{
    "cn": "test.go.kr",
    "name": "test-certificate",
    "not_after_dt": "20251212",
    "not_before_dt": "20250101",
    "organization": "samsungSDS",
    "recipients": [],
    "region": "west1",
    "tags": [],
    "timezone": "Asia/Seoul"
}

Example HTTP response

Response 201

{
    "certificate": {
        "account_id": "b82909b3576449fda984fb25c3123542da",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "DEV",
        "cert_type": "pem",
        "cert_version": "2",
        "cn": "test.go.kr",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "key_bit_size": "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": "samsungSDS",
        "private_key": "",
        "state": "VALID",
        "user_name": "2048"
    }
}

1.1.7 - Validate a certificate

1.1.7.1 - 1.1

post /v1/certificatemanager/check-validation

Description

인증서 검증

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateValidateRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	CertificateValidateResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/check-validation

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.1"

Request body

{
    "cert_body": "<encoded certificate body data>",
    "cert_chain": "<encoded certificate chain data>",
    "private_key": "<encoded private key data>"
}

Example HTTP response

Response 200

{
    "validate_check": ""
}

1.1.7.2 - 1.0

post /v1/certificatemanager/check-validation

Description

인증서 검증

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		CertificateValidateRequest

Responses

HTTP Code	Description	Schema
200	OK	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/certificatemanager/check-validation

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = certificatemanager 1.0"

Request body

{
    "cert_body": "<encoded certificate body data>",
    "cert_chain": "<encoded certificate chain data>",
    "is_need_cert_chain": "True",
    "private_key": "<encoded private key data>"
}

Example HTTP response

Response 200

{
    "result": true
}

1.2 - Models

1.2.1 - CertificateCreate

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

1.2.2 - CertificateCreateRequest

Name	Description	Schema
cert_body required	인증서 body Example : `<encoded certificate body data>`	string
cert_chain optional	인증서 체인 Example : `<encoded certificate chain data>`	any of [string, null]
name required	인증서 이름 Example : `test-certificate`	string
private_key required	개인키 Example : `<encoded private key data>`	string
recipients optional	만료된 인증서 수신인 Example : `[{'region': '', 'user_id': 'sdaFDQSDADZ2488e195c0e97d9b9eb', 'user_name': 'kildong.hong'}]`	array[Recipient]
region required	리즌 이름 Example : `west1`	string
tags optional	태그 리스트	array[Tag]
timezone required	타임존 Example : `Asia/Seoul`	string

1.2.3 - CertificateCreateResponse

Name	Description	Schema	Default
certificate required		CertificateCreate

1.2.4 - CertificateDetail

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

1.2.5 - CertificateDetailResponse

Name	Description	Schema	Default
certificate required		CertificateDetail

1.2.6 - CertificateDuplicateRequest

Name	Description	Schema	Default
name required	인증서 이름 Example :	string

1.2.7 - CertificateList

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

1.2.8 - CertificateListResponse

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

1.2.9 - CertificateValidateRequest

Name	Description	Schema
cert_body required	인증서 body Example : `<encoded certificate body data>`	string
cert_chain optional	인증서 체인 Example : `<encoded certificate chain data>`	any of [string, null]
is_need_cert_chain required	인증서 체인 필요 여부 Example : `True`	boolean
private_key required	개인키 Example : `<encoded private key data>`	string

1.2.10 - CertificateValidateRequestV1Dot1

Name	Description	Schema
cert_body required	인증서 body Example : `<encoded certificate body data>`	string
cert_chain optional	인증서 체인 Example : `<encoded certificate chain data>`	any of [string, null]
private_key required	개인키 Example : `<encoded private key data>`	string

1.2.11 - CertificateValidateResponseV1Dot1

Name	Description	Schema	Default
validate_check required	Example :	boolean

1.2.12 - CheckResponse

Name	Description	Schema	Default
result required	True, False 체크 Example : `True`	boolean

1.2.13 - Recipient

Name	Description	Schema
region required	리즌 이름 Example :	string
user_id required	사용자 id Example :	string
user_name required	사용자 이름 Example :	string

1.2.14 - SelfSignCreateRequest

Name	Description	Schema
cn required	인증서 CN 정보 Example : `test.go.kr`	string
name required	인증서 이름 Example : `test-certificate`	string
not_after_dt required	인증서 만료일 Example : `20251212`	string
not_before_dt required	인증서 시작일 Example : `20250101`	string
organization required	인증서 O(조직) 정보 Example : `samsungSDS`	string
recipients optional	만료된 인증서 수신인	array[Recipient]
region required	리즌 이름 Example : `west1`	string
tags optional	태그 리스트	array[Tag]
timezone required	타임존 Example : `Asia/Seoul`	string

1.2.15 - Tag

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

2 - Config Inspection

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Config Inspection 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	SUPPORTED	20260531
1.1	CURRENT	-

OpenAPI URL

https://configinspection.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

2.1 - APIs

2.1.1 - Create Config Inspection

2.1.1.1 - 1.1

post /v1/configinspection/diagnosis/save

Description

진단 상품 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DiagnosisObjectRequest

Responses

HTTP Code	Description	Schema
201	Created	ConfigInspectionCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/save

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Request body

{
    "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "auth_key_request": {
        "auth_key_created_at": "2022-01-01 12:00:00",
        "auth_key_expired_at": "2023-01-01 12:00:00",
        "auth_key_id": "9b72a9856e494e67afc69atd3631fe38",
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097"
    },
    "csp_type": "SCP",
    "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "diagnosis_name": "Sample Diagnosis Name",
    "diagnosis_type": "Console",
    "plan_type": "STANDARD",
    "schedule_request": {
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
        "diagnosis_start_time_pattern": "08:00",
        "frequency_type": "MONTH",
        "frequency_value": "1",
        "use_diagnosis_check_type_bp": "y",
        "use_diagnosis_check_type_ssi": "y"
    },
    "tags": []
}

Example HTTP response

Response 201

{
    "diagnosis_id": "Sample Diagnosis Name",
    "result": true
}

2.1.1.2 - 1.0

post /v1/configinspection/diagnosis/save

Description

진단 상품 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		DiagnosisObjectRequest

Responses

HTTP Code	Description	Schema
201	Created	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/save

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Request body

{
    "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "auth_key_request": {
        "auth_key_created_at": "2022-01-01 12:00:00",
        "auth_key_expired_at": "2023-01-01 12:00:00",
        "auth_key_id": "9b72a9856e494e67afc69atd3631fe38",
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097"
    },
    "csp_type": "SCP",
    "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "diagnosis_name": "Sample Diagnosis Name",
    "diagnosis_type": "Console",
    "plan_type": "STANDARD",
    "schedule_request": {
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
        "diagnosis_start_time_pattern": "08:00",
        "frequency_type": "MONTH",
        "frequency_value": "1",
        "use_diagnosis_check_type_bp": "y",
        "use_diagnosis_check_type_ssi": "y"
    },
    "tags": []
}

Example HTTP response

Response 201

{
    "result": true
}

2.1.2 - Delete Config Inspection

2.1.2.1 - 1.1

delete /v1/configinspection/diagnosis/terminate/{diagnosis_id}

Description

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	diagnosis_id required	진단 ID Example : `Sample Diagnosis Name`	string	None

Responses

HTTP Code	Description	Schema
200	OK	TerminateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/terminate/{diagnosis_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Example HTTP response

Response 200

{
    "delete_flag": true,
    "msg": "Delete success"
}

2.1.2.2 - 1.0

delete /v1/configinspection/diagnosis/terminate/{diagnosis_id}

Description

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	diagnosis_id required	진단 ID Example : `Sample Diagnosis Name`	string	None

Responses

HTTP Code	Description	Schema
200	OK	TerminateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/terminate/{diagnosis_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Example HTTP response

Response 200

{
    "delete_flag": true,
    "msg": "Delete success"
}

2.1.3 - Diagnosis Request

2.1.3.1 - 1.1

post /v1/configinspection/diagnosis/request

Description

진단 요청

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DiagnosisRequest

Responses

HTTP Code	Description	Schema
201	Created	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/request

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Request body

{
    "access_key": "SAMPLE KEY",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "secret_key": "SAMPLE KEY",
    "tenant_id": "1234567890"
}

Example HTTP response

Response 201

{
    "result": true
}

2.1.3.2 - 1.0

post /v1/configinspection/diagnosis/request

Description

진단 요청

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		DiagnosisRequest

Responses

HTTP Code	Description	Schema
201	Created	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/request

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Request body

{
    "access_key": "SAMPLE KEY",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "secret_key": "SAMPLE KEY",
    "tenant_id": "1234567890"
}

Example HTTP response

Response 201

{
    "result": true
}

2.1.4 - Disgnosis Response

2.1.4.1 - 1.1

post /v1/configinspection/diagnosis/response

Description

진단 요청

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		ConfigInspectionLookinResponse

Responses

HTTP Code	Description	Schema
201	Created	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/response

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Request body

{
    "requestNumber": "",
    "systemId": "",
    "targets": {
        "cloudAccountId": "",
        "cspCd": "",
        "cspConsoleCd": "",
        "error": {
            "message": "",
            "type": ""
        },
        "kind": "",
        "result": [],
        "status": "",
        "version": ""
    }
}

Example HTTP response

Response 201

{
    "result": true
}

2.1.4.2 - 1.0

post /v1/configinspection/diagnosis/response

Description

진단 요청

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		ConfigInspectionLookinResponse

Responses

HTTP Code	Description	Schema
201	Created	CheckResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/response

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Request body

{
    "requestNumber": "",
    "systemId": "",
    "targets": {
        "cloudAccountId": "",
        "cspCd": "",
        "cspConsoleCd": "",
        "error": {
            "message": "",
            "type": ""
        },
        "kind": "",
        "result": [],
        "status": "",
        "version": ""
    }
}

Example HTTP response

Response 201

{
    "result": true
}

2.1.5 - Get Diagnosis Object Detail

2.1.5.1 - 1.1

get /v1/configinspection/diagnosis/detail/{diagnosis_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	diagnosis_id required	진단 ID Example : `Sample Diagnosis Name`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisObjectDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/detail/{diagnosis_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Example HTTP response

Response 200

{
    "auth_key_responses": {
        "auth_key_created_at": "2022-01-01T12:00:00Z",
        "auth_key_expired_at": "2022-01-01T12:00:00Z",
        "auth_key_id": "9b72a9856e494e67afc69atd3631fe38",
        "auth_key_state": "ACTIVATED",
        "user_id": "4f5d60e9e08b48d0a0881e21ab14e266"
    },
    "schedule_response": {
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
        "diagnosis_start_time_pattern": "08:00",
        "frequency_type": "MONTH",
        "frequency_value": "1",
        "use_diagnosis_check_type_bp": "y",
        "use_diagnosis_check_type_ssi": "y"
    },
    "summary_responses": {
        "created_at": "2022-01-01T12:00:00Z",
        "csp_type": "SCP",
        "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "diagnosis_check_type": "BP",
        "diagnosis_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.5.2 - 1.0

get /v1/configinspection/diagnosis/detail/{diagnosis_id}

Description

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	diagnosis_id required	진단 ID Example : `Sample Diagnosis Name`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisObjectDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/detail/{diagnosis_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Example HTTP response

Response 200

{
    "auth_key_responses": {
        "auth_key_created_at": "2022-01-01T12:00:00Z",
        "auth_key_expired_at": "2022-01-01T12:00:00Z",
        "auth_key_id": "9b72a9856e494e67afc69atd3631fe38",
        "auth_key_state": "ACTIVATED",
        "user_id": "4f5d60e9e08b48d0a0881e21ab14e266"
    },
    "schedule_response": {
        "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
        "diagnosis_start_time_pattern": "08:00",
        "frequency_type": "MONTH",
        "frequency_value": "1",
        "use_diagnosis_check_type_bp": "y",
        "use_diagnosis_check_type_ssi": "y"
    },
    "summary_responses": {
        "created_at": "2022-01-01T12:00:00Z",
        "csp_type": "SCP",
        "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "diagnosis_check_type": "BP",
        "diagnosis_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 - Get Diagnosis Result Detail

2.1.6.1 - 1.1

get /v1/configinspection/report/diagnosis/detail

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	diagnosis_id required	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string	None
query	diagnosis_request_sequence required	진단 요청 Sequence Example : `SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisResultDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/report/diagnosis/detail?diagnosis_id={diagnosis_id}&diagnosis_request_sequence={diagnosis_request_sequence}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Example HTTP response

Response 200

{
    "checklist_name": "Sample Checklist",
    "count": 20,
    "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "diagnosis_name": "Sample Diagnosis Name",
    "diagnosis_request_sequence": "SCPCIS-E75FD21CA524441C9C1B1B381D5974F7",
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "proceed_date": "2026-02-11T06:41:21.874Z",
    "result_detail_list": [
        {
            "action_guide": "원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.",
            "changed": true,
            "diagnosis_check_type": "BP",
            "diagnosis_criteria": "【 Security Group 규칙 】\r\n① 원격접속 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": "NURIBP_SCP_02.NW_004"
        }
    ],
    "total": 10
}

2.1.6.2 - 1.0

get /v1/configinspection/report/diagnosis/detail

Description

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

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	diagnosis_id required	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string	None
query	diagnosis_request_sequence required	진단 요청 Sequence Example : `SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisResultDetailResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/report/diagnosis/detail?diagnosis_id={diagnosis_id}&diagnosis_request_sequence={diagnosis_request_sequence}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Example HTTP response

Response 200

{
    "checklist_name": "Sample Checklist",
    "count": 20,
    "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
    "diagnosis_check_type": "BP",
    "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
    "diagnosis_name": "Sample Diagnosis Name",
    "diagnosis_request_sequence": "SCPCIS-E75FD21CA524441C9C1B1B381D5974F7",
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "proceed_date": "2026-02-11T06:41:21.874Z",
    "result_detail_list": [
        {
            "action_guide": "원격 접속 Port에 Source IP가 ANY(0.0.0.0/0)로 등록되어있거나 과도하게 허용된 Security Group 규칙은 아래와 같이 삭제합니다.",
            "changed": true,
            "diagnosis_check_type": "BP",
            "diagnosis_criteria": "【 Security Group 규칙 】\r\n① 원격접속 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": "NURIBP_SCP_02.NW_004"
        }
    ],
    "total": 10
}

2.1.7 - List Config Inspection

2.1.7.1 - 1.1

get /v1/configinspection/diagnosis/list

Description

config inspection 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	ConfigInspectionListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/list

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "summary_responses": [
        {
            "created_at": "2022-01-01T12:00:00Z",
            "csp_type": "SCP",
            "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "diagnosis_check_type": "BP",
            "diagnosis_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.2 - 1.0

get /v1/configinspection/diagnosis/list

Description

config inspection 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	ConfigInspectionListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/diagnosis/list

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "summary_responses": [
        {
            "created_at": "2022-01-01T12:00:00Z",
            "csp_type": "SCP",
            "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "diagnosis_check_type": "BP",
            "diagnosis_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.8 - List Diagnosis Result

2.1.8.1 - 1.1

get /v1/configinspection/report/diagnosis/list

Description

진단 결과 목록 가져오기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisResultListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/report/diagnosis/list

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "diagnosis_result_responses": [
        {
            "count_check": 10,
            "count_error": 0,
            "count_fail": 3,
            "count_na": 2,
            "count_pass": 5,
            "csp_type": "SCP",
            "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "diagnosis_check_type": "BP",
            "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
            "diagnosis_name": "Sample Diagnosis Name",
            "diagnosis_request_sequence": "1234567890",
            "diagnosis_result": "SUCCESS",
            "diagnosis_total_count": 10,
            "proceed_date": "2022-01-01T12:00:00Z",
            "total": 10
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

2.1.8.2 - 1.0

get /v1/configinspection/report/diagnosis/list

Description

진단 결과 목록 가져오기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260531

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	DiagnosisResultListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/configinspection/report/diagnosis/list

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = configinspection 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "diagnosis_result_responses": [
        {
            "count_check": 10,
            "count_error": 0,
            "count_fail": 3,
            "count_na": 2,
            "count_pass": 5,
            "csp_type": "SCP",
            "diagnosis_account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "diagnosis_check_type": "BP",
            "diagnosis_id": "DIA-943731CB8E3045C289BAECAEC3532097",
            "diagnosis_name": "Sample Diagnosis Name",
            "diagnosis_request_sequence": "1234567890",
            "diagnosis_result": "SUCCESS",
            "diagnosis_total_count": 10,
            "proceed_date": "2022-01-01T12:00:00Z",
            "total": 10
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

2.2 - Models

2.2.1 - AuthKeyRequest

Name	Description	Schema
auth_key_created_at optional	인증 키 생성 날짜 Example : `2022-01-01 12:00:00`	any of [string, null]
auth_key_expired_at optional	인증 키 만료 날짜 Example : `2023-01-01 12:00:00`	any of [string, null]
auth_key_id required	인증키 ID Example : `9b72a9856e494e67afc69atd3631fe38`	string
diagnosis_id optional	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	any of [string, null]

2.2.2 - AuthKeyResponse

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

2.2.3 - CheckResponse

Name	Description	Schema	Default
result required	True, False 체크 Example : `True`	boolean

2.2.4 - ConfigInspectionCreateResponse

Name	Description	Schema	Default
diagnosis_id required	진단 ID Example : `Sample Diagnosis Name`	string
result required	True, False 체크 Example : `True`	boolean

2.2.5 - ConfigInspectionListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
summary_responses required		array[SummaryResponse]

2.2.6 - ConfigInspectionLookinError

Name	Description	Schema	Default
message optional	Example :	string
type optional	Example :	string

2.2.7 - ConfigInspectionLookinResponse

Name	Description	Schema
requestNumber required	Example :	string
systemId required	Example :	string
targets required		ConfigInspectionLookinTarget

2.2.8 - ConfigInspectionLookinResult

Name	Description	Schema
current optional	Example :	string
itemCode required	Example :	string
verify optional	Example :	string

2.2.9 - ConfigInspectionLookinTarget

Name	Description	Schema
cloudAccountId required	Example :	string
cspCd required	Example :	string
cspConsoleCd required	Example :	string
error optional		any of [ConfigInspectionLookinError, null]
kind optional	Example :	string
result optional		array[ConfigInspectionLookinResult]
status optional	Example :	string
version optional	Example :	string

2.2.10 - DiagnosisObjectDetailResponse

Name	Description	Schema	Default
auth_key_responses required		AuthKeyResponse
schedule_response required		DiagnosisScheduleResponse
summary_responses required		SummaryResponse

2.2.11 - DiagnosisObjectRequest

Name	Description	Schema
account_id required	진단 계정 Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
auth_key_request required		AuthKeyRequest
csp_type required	클라우드 서비스 제공자의 유형 Example : `SCP`	string
diagnosis_account_id required	진단 ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	진단 체크리스트 Example : `BP`	string
diagnosis_id required	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	진단명 Example : `Sample Diagnosis Name` Pattern : `^[a-zA-Z0-9-_]+$` Maximum length : `25`	string
diagnosis_type required	진단 유형 Example : `Console`	string
plan_type required	요금제 Example : `STANDARD`	string
schedule_request required		DiagnosisScheduleRequest
tags optional	Tag List	array[Tag]

2.2.12 - DiagnosisRequest

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

2.2.13 - DiagnosisResultDetail

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

2.2.14 - DiagnosisResultDetailResponse

Name	Description	Schema
checklist_name required	체크리스트 이름 Example : `Sample Checklist`	string
count optional	전체 개수 Example : `20`	any of [integer, null]
diagnosis_account_id required	진단 ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
diagnosis_check_type required	진단 체크리스트 Example : `BP`	string
diagnosis_id required	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_name required	진단명 Example : `Sample Diagnosis Name`	string
diagnosis_request_sequence required	진단 요청 Sequence Example : `SCPCIS-E75FD21CA524441C9C1B1B381D5974F7`	string
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
proceed_date optional	진단 일자 Example : `2026-02-11T06:41:21.874Z`	string (date-time)
result_detail_list required		array[DiagnosisResultDetail]
total required	전체 개수 Example : `10`	integer

2.2.15 - DiagnosisResultListResponse

Name	Description	Schema
count optional	전체 개수 Example : `20`	any of [integer, null]
diagnosis_result_responses required		array[DiagnosisResultResponse]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

2.2.16 - DiagnosisResultResponse

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

2.2.17 - DiagnosisScheduleRequest

Name	Description	Schema
diagnosis_id required	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_start_time_pattern required	시작 시간( 5분 단위, 00 to 23 시, 00 to 55 분 ) Example : `08:00`	string
frequency_type required	스케줄 유형(매월, 매주, 매일) Example : `MONTH`	string
frequency_value required	스케줄 진단 주기 value(01~31, 월~일, 매일) Example : `1`	string
use_diagnosis_check_type_bp required	체크리스트 Best Practice 사용 여부 Example : `y`	string
use_diagnosis_check_type_ssi required	체크리스트 SSI 사용 여부 Example : `y`	string

2.2.18 - DiagnosisScheduleResponse

Name	Description	Schema
diagnosis_id optional	진단 ID Example : `DIA-943731CB8E3045C289BAECAEC3532097`	string
diagnosis_start_time_pattern optional	시작 시간( 5분 단위, 00 to 23 시, 00 to 55 분 ) Example : `08:00`	string
frequency_type optional	스케줄 유형(매월, 매주, 매일) Example : `MONTH`	string
frequency_value optional	스케줄 진단 주기 value(01~31, 월~일, 매일) Example : `1`	string
use_diagnosis_check_type_bp optional	체크리스트 Best Practice 사용 여부 Example : `y`	string
use_diagnosis_check_type_ssi optional	체크리스트 SSI 사용 여부 Example : `y`	string

2.2.19 - SummaryResponse

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

2.2.20 - Tag

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

2.2.21 - TerminateResponse

Name	Description	Schema	Default
delete_flag required	True, False 체크 Example : `True`	boolean
msg required	삭제 메시지 Example : `Delete success`	string

3 - Key Management Service

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Key Management Service(KMS)에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

https://kms.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

3.1 - APIs

3.1.1 - Change Rotate Info

3.1.1.1 - 1.1

put /v1/kms/transit/{key_id}/rotate-info

Description

키 회전정보를 변경한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyRotateInfoRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/rotate-info

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "auto_rotate": "Y",
    "rotate_cycle": 7
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.1.2 - 1.0

put /v1/kms/transit/{key_id}/rotate-info

Description

키 회전정보를 변경한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyRotateInfoRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/rotate-info

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "auto_rotate": "Y",
    "rotate_cycle": 7
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.2 - Change State Of Key

3.1.2.1 - 1.1

put /v1/kms/transit/{key_id}/state

Description

키 상태를 변경한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyStateRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "state": "Active"
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.2.2 - 1.0

put /v1/kms/transit/{key_id}/state

Description

키 상태를 변경한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyStateRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "state": "Active"
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.3 - Check Duplicate Name

3.1.3.1 - 1.1

get /v1/kms/transit/duplicate

Description

키 이름 중복을 체크한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	name required	키 이름 Example : `testkey`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyNameDuplicateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/duplicate?name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 200

{
    "isDuplicateName": true
}

3.1.3.2 - 1.0

get /v1/kms/transit/duplicate

Description

키 이름 중복을 체크한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	name required	키 이름 Example : `testkey`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyNameDuplicateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/duplicate?name={name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 200

{
    "isDuplicateName": true
}

3.1.4 - Create Datakey

3.1.4.1 - 1.1

post /v1/kms/openapi/datakey/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		DatakeyRequest

Responses

HTTP Code	Description	Schema
200	OK	DatakeyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/datakey/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "key_type": "plaintext"
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1,
    "plaintext": "oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA="
}

3.1.4.2 - 1.0

post /v1/kms/openapi/datakey/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		DatakeyRequest

Responses

HTTP Code	Description	Schema
200	OK	DatakeyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/datakey/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "key_type": "plaintext"
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1,
    "plaintext": "oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA="
}

3.1.5 - Create Key

3.1.5.1 - 1.1

post /v1/kms/transit

Description

키를 생성한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		KeyCreateMasterKeyRequest

Responses

HTTP Code	Description	Schema
201	Created	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "auto_rotate": "Y",
    "description": "description1",
    "key_type": "advanced",
    "name": "testkey",
    "purpose": "rsa-2048",
    "rotate_cycle": 7,
    "tags": []
}

Example HTTP response

Response 201

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.5.2 - 1.0

post /v1/kms/transit

Description

키를 생성한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		KeyCreateMasterKeyRequest

Responses

HTTP Code	Description	Schema
201	Created	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "auto_rotate": "Y",
    "description": "description1",
    "key_type": "advanced",
    "name": "testkey",
    "purpose": "rsa-2048",
    "rotate_cycle": 7,
    "tags": []
}

Example HTTP response

Response 201

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.6 - Decrypt Data

3.1.6.1 - 1.1

post /v1/kms/openapi/decrypt/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		DecryptRequest

Responses

HTTP Code	Description	Schema
200	OK	DecryptResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/decrypt/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK"
}

Example HTTP response

Response 200

{
    "plaintext": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}

3.1.6.2 - 1.0

post /v1/kms/openapi/decrypt/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		DecryptRequest

Responses

HTTP Code	Description	Schema
200	OK	DecryptResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/decrypt/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK"
}

Example HTTP response

Response 200

{
    "plaintext": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}

3.1.7 - Delete Key

3.1.7.1 - 1.1

delete /v1/kms/transit/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	is_directly optional	즉시삭제 여부 Example : `True`	boolean	False

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 204

3.1.7.2 - 1.0

delete /v1/kms/transit/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
query	is_directly optional	즉시삭제 여부 Example : `True`	boolean	False

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 204

3.1.8 - Encrypt Data

3.1.8.1 - 1.1

post /v1/kms/openapi/encrypt/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		EncryptRequest

Responses

HTTP Code	Description	Schema
200	OK	EncryptResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/encrypt/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "plaintext": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1
}

3.1.8.2 - 1.0

post /v1/kms/openapi/encrypt/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		EncryptRequest

Responses

HTTP Code	Description	Schema
200	OK	EncryptResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/encrypt/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "plaintext": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1
}

3.1.9 - List Keys

3.1.9.1 - 1.1

get /v1/kms/transit

Description

키 리스트 조회하기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	키 이름 Example : `testkey`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeyPageResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "keys": [
        {
            "account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "auto_rotate": "Y",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "current_version": 7,
            "delete_at": "20251008",
            "delete_target_yn": "Y",
            "description": "description1",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "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": "Active",
            "use_count": 1004
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.9.2 - 1.0

get /v1/kms/transit

Description

키 리스트 조회하기

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	키 이름 Example : `testkey`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeyPageResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "keys": [
        {
            "account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "auto_rotate": "Y",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "current_version": 7,
            "delete_at": "20251008",
            "delete_target_yn": "Y",
            "description": "description1",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "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": "Active",
            "use_count": 1004
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.10 - List Users

3.1.10.1 - 1.1

get /v1/kms/transit/{key_id}/users

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyUserResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}

3.1.10.2 - 1.0

get /v1/kms/transit/{key_id}/users

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyUserResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/users

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 200

{
    "user": [
        {
            "user_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "user_name": "kimsamsung"
        }
    ]
}

3.1.11 - Make hmac

3.1.11.1 - 1.1

post /v1/kms/openapi/hmac/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		HmacRequest

Responses

HTTP Code	Description	Schema
200	OK	HmacResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/hmac/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "hmac": "vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ="
}

3.1.11.2 - 1.0

post /v1/kms/openapi/hmac/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		HmacRequest

Responses

HTTP Code	Description	Schema
200	OK	HmacResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/hmac/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "hmac": "vault:v1:/IHSD+Rg9BHNkmIiEunAPVj6IVaJqkjSO4GGvALHcVQ="
}

3.1.12 - Rewrap Data

3.1.12.1 - 1.1

post /v1/kms/openapi/rewrap/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		RewrapRequest

Responses

HTTP Code	Description	Schema
200	OK	RewrapResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/rewrap/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK"
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1
}

3.1.12.2 - 1.0

post /v1/kms/openapi/rewrap/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		RewrapRequest

Responses

HTTP Code	Description	Schema
200	OK	RewrapResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/rewrap/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK"
}

Example HTTP response

Response 200

{
    "ciphertext": "vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK",
    "key_version": 1
}

3.1.13 - Rotate Key

3.1.13.1 - 1.1

post /v1/kms/transit/{key_id}/rotate

Description

키를 회전한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/rotate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.13.2 - 1.0

post /v1/kms/transit/{key_id}/rotate

Description

키를 회전한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/rotate

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.14 - Show Key

3.1.14.1 - 1.1

get /v1/kms/transit/{key_id}

Description

키 정보를 보여준다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.14.2 - 1.0

get /v1/kms/transit/{key_id}

Description

키 정보를 보여준다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.15 - Sign Data

3.1.15.1 - 1.1

post /v1/kms/openapi/sign/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		SignRequest

Responses

HTTP Code	Description	Schema
200	OK	SignResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/sign/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "key_version": 1,
    "signature": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg="
}

3.1.15.2 - 1.0

post /v1/kms/openapi/sign/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		SignRequest

Responses

HTTP Code	Description	Schema
200	OK	SignResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/sign/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "key_version": 1,
    "signature": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg="
}

3.1.16 - Update Description

3.1.16.1 - 1.1

put /v1/kms/transit/{key_id}/description

Description

설명을 업데이트한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.16.2 - 1.0

put /v1/kms/transit/{key_id}/description

Description

설명을 업데이트한다.

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		KeyDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	KeyShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/kms/transit/{key_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "key": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "auto_rotate": "Y",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "current_version": 7,
        "delete_at": "20251008",
        "delete_target_yn": "Y",
        "description": "description1",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "use_count": 1004
    }
}

3.1.17 - Verify Data

3.1.17.1 - 1.1

post /v1/kms/openapi/verify/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		VerifyRequest

Responses

HTTP Code	Description	Schema
200	OK	VerifyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/verify/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "input": "dGVzdCBpbnB1dA==",
    "signature": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg="
}

Example HTTP response

Response 200

{
    "valid": true
}

3.1.17.2 - 1.0

post /v1/kms/openapi/verify/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		VerifyRequest

Responses

HTTP Code	Description	Schema
200	OK	VerifyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/verify/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "input": "dGVzdCBpbnB1dA==",
    "signature": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg="
}

Example HTTP response

Response 200

{
    "valid": true
}

3.1.18 - Verify hmac with input

3.1.18.1 - 1.1

post /v1/kms/openapi/hmac/verify/{key_id}

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		HmacVerifyRequest

Responses

HTTP Code	Description	Schema
200	OK	HmacVerifyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/hmac/verify/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.1"

Request body

{
    "hmac": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=",
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "valid": true
}

3.1.18.2 - 1.0

post /v1/kms/openapi/hmac/verify/{key_id}

Description

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

상태 ACTIVE (DEPRECATED)

버전	최소 지원 보장일
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	key_id required	KMS 키 자원 아이디 Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string	None
body	body required		HmacVerifyRequest

Responses

HTTP Code	Description	Schema
200	OK	HmacVerifyResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/kms/openapi/hmac/verify/{key_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = kms 1.0"

Request body

{
    "hmac": "vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=",
    "input": "dGVzdCBpbnB1dA=="
}

Example HTTP response

Response 200

{
    "valid": true
}

3.2 - Models

3.2.1 - DatakeyRequest

Name	Description	Schema	Default
key_type required	키 타입( plaintext or wrapped ) Example : `plaintext`	string

3.2.2 - DatakeyResponse

Name	Description	Schema
ciphertext required	암호화된 데이터 키 Example : `vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string
key_version required	KMS 키 버전 Example : `1`	integer
plaintext required	데이터키 (base64로 인코딩된) Example : `oTvvEkE7q0WM2S5yfGFz5nqe32QMlrCVnqssmDPu6fA=`	any of [string, null]

3.2.3 - DecryptRequest

Name	Description	Schema	Default
ciphertext required	KMS에 의해 암호화된 데이터 Example : `vault:v283:YiUpW1bpF2fMY0VR332Qpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string

3.2.4 - DecryptResponse

Name	Description	Schema	Default
plaintext required	데이터키 (base64로 인코딩된 ) Example : `dGhlIHF1aWNrIGJyb3duIGZveAo=`	string

3.2.5 - EncryptRequest

Name	Description	Schema	Default
plaintext required	base64로 인코딩된 확인하기 위한 데이터 Example : `dGhlIHF1aWNrIGJyb3duIGZveAo=`	string

3.2.6 - EncryptResponse

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

3.2.7 - HmacRequest

Name	Description	Schema	Default
input required	base64로 인코딩된 확인하기 위한 데이터 Example : `dGVzdCBpbnB1dA==`	string

3.2.8 - HmacResponse

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

3.2.9 - HmacVerifyRequest

Name	Description	Schema	Default
hmac required	확인을 위한 시그니쳐 Example : `vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`	string
input required	base64로 인코딩된 확인하기 위한 데이터 Example : `dGVzdCBpbnB1dA==`	string

3.2.10 - HmacVerifyResponse

Name	Description	Schema	Default
valid required	확인결과 Example : `True`	boolean

3.2.11 - Key

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

3.2.12 - KeyCreateMasterKeyRequest

Name	Description	Schema	Default
auto_rotate required	자동회전 Y 또는 N Example : `Y`	string
description required	키 설명 Example : `description1` Maximum length : `100`	string
key_type optional	기본 또는 고급 Example : `advanced`	enum (basic, advanced)	advanced
name required	키 이름 Example : `testkey` Pattern : `^[a-z0-9]$` Minimum length* : `3` Maximum length : `63`	string
purpose required	키 용도 Example : `rsa-2048`	string
rotate_cycle required	회전 주기 Example : `7`	integer
tags optional	태그 리스트	array[Tag]

3.2.13 - KeyDescriptionRequest

Name	Description	Schema	Default
description required	키 설명 Example : Maximum length : `100`	string

3.2.14 - KeyNameDuplicateResponse

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

3.2.15 - KeyPageResponse

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

3.2.16 - KeyRotateInfoRequest

Name	Description	Schema	Default
auto_rotate required	자동회전 Y 또는 N Example : `Y` Pattern : `^[YN]$`	string
rotate_cycle required	회전 주기 Example : `7`	any of [integer, null]

3.2.17 - KeyShowResponse

Name	Description	Schema	Default
key required		Key

3.2.18 - KeyStateRequest

Name	Description	Schema	Default
state required	키 상태(Active, Stop) Example : `Active` Pattern : `^(Active\|Stop)$`	string

3.2.19 - KeyUserResponse

Name	Description	Schema	Default
user required		array[User]

3.2.20 - RewrapRequest

Name	Description	Schema	Default
ciphertext required	KMS에 의해 암호화된 데이터 Example : `vault:v283:YiUpW1bpF2fMY0VR33aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK`	string

3.2.21 - RewrapResponse

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

3.2.22 - SignRequest

Name	Description	Schema	Default
input required	base64로 인코딩된 확인하기 위한 데이터 Example : `dGVzdCBpbnB1dA==`	string

3.2.23 - SignResponse

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

3.2.24 - Tag

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

3.2.25 - User

Name	Description	Schema	Default
user_id required	사용자 id Example : `138c2fc8c29a449dbfa8681f8f1d78e2`	string
user_name required	사용자 이름 Example : `kimsamsung`	string

3.2.26 - VerifyRequest

Name	Description	Schema	Default
input required	base64로 인코딩된 확인하기 위한 데이터 Example : `dGVzdCBpbnB1dA==`	string
signature required	확인을 위한 시그니쳐 Example : `vault:v142:MEUCIQDt+iM27ZENLTxFCKH2krlvn2xRRuoqt8aU+xP/RYEJpgIgN6V6QjhpK4dA/vwgX95UW140ge167ECnLjccXDPbZAg=`	string

3.2.27 - VerifyResponse

Name	Description	Schema	Default
valid required	확인결과 Example : `True`	boolean

4 - Secret Vault

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Secret Vault에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://secretvault.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

4.1 - APIs

4.1.1 - Create Secret Vault

4.1.1.1 - 1.0

post /v1/secretvault

Description

시크릿볼트 생성.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretVaultCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecretVaultCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secretvault

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretvault 1.0"

Request body

{
    "access_key_id": "b754b12b39da4ce29a40c5e324650bd0",
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
    "description": "description",
    "name": "name",
    "tags": [],
    "temporary_key_ttl_nhours": "3",
    "vault_token_ttl_ndays": "720"
}

Example HTTP response

Response 201

{
    "secret_vault": {
        "access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "access_key_type": "Temporary",
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "vaultkey_type": "SCP Open API Key",
        "waiting_time_ndays": "10"
    }
}

4.1.2 - Delete Secret Vault

4.1.2.1 - 1.0

put /v1/secretvault/{secret_vault_id}/terminated

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_vault_id required	시크릿볼트 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretVaultTerminatedRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretVaultShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secretvault/{secret_vault_id}/terminated

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretvault 1.0"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 200

{
    "secret_vault": {
        "access_key": [
            "0e3*****************************"
        ],
        "access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "access_key_type": [
            "Temporary",
            "Permanent"
        ],
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "vaultkey_type": [
            "SCP Open API Key"
        ],
        "waiting_time_ndays": "10"
    }
}

4.1.3 - Get Temporary Key

4.1.3.1 - 1.0

get /v1/temporarykey/{secret_vault_id}

Description

임시키 조회하기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
header	Svaccesskey required	시크릿볼트가 발행한 token id Example : `5dbd99e4-aad4-e822-9ab3-89b10cf7c9ef`	string	None
header	Svsignature required	호출 API 요청을 Access Key와 매핑되는 Access Secret Key(시크릿볼트가 발행한 token secret)로 암호화한 서명. HMAC 암호화 알고리즘은 HmacSHA256 사용 Example : `fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=`	string	None
header	Svtimestamp required	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 정의합니다. Example : `1605290625682`	string	None
header	Svclienttype required	Client Type Example : `Openapi`	string	None
path	secret_vault_id required	시크릿볼트 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretVaultTemporaryKeyResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/temporarykey/{secret_vault_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretvault 1.0"

Example HTTP response

Response 200

{
    "access_key": "testname",
    "expired_at": "2025-02-25 03:07:17.000",
    "secret_key": "testname"
}

4.1.4 - List Secret Vaults

4.1.4.1 - 1.0

get /v1/secretvault

Description

시크릿볼트 리스트 조회

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Responses

HTTP Code	Description	Schema
200	OK	SecretVaultKeyListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secretvault

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretvault 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secret_vaults": [
        {
            "access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "access_key_type": "Temporary",
            "account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_at": "2025-02-25 03:07:17.000",
            "description": "description",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "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": "Active",
            "vaultkey_type": "SCP Open API Key",
            "waiting_time_ndays": "10"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4.1.5 - Show Secret Vault

4.1.5.1 - 1.0

get /v1/secretvault/{secret_vault_id}

Description

시크릿볼트 조회.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_vault_id required	시크릿볼트 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretVaultShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secretvault/{secret_vault_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretvault 1.0"

Example HTTP response

Response 200

{
    "secret_vault": {
        "access_key": [
            "0e3*****************************"
        ],
        "access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "access_key_type": [
            "Temporary",
            "Permanent"
        ],
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "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": "Active",
        "vaultkey_type": [
            "SCP Open API Key"
        ],
        "waiting_time_ndays": "10"
    }
}

4.2 - Models

4.2.1 - SecretVaultCreateRequest

Name	Description	Schema
access_key_id required	Access key ID Example : `b754b12b39da4ce29a40c5e324650bd0`	string
acl_cidr required	접근제한을 위한 CIDR Example : `192.168.1.1/24, 10.0.0.1/16`	string
description optional	Description Example : `description`	any of [string, null]
name required	시크릿볼트 아이디 Example : `name` Pattern : `^[a-z0-9]$` Minimum length* : `3` Maximum length : `63`	string
tags optional	태그 리스트	any of [array[Tag], null]
temporary_key_ttl_nhours required	임시키 유효 시간 Example : `3` Minimum : `1` Maximum : `36`	integer
vault_token_ttl_ndays required	볼트 토큰 유효시간 Example : `720` Minimum : `30` Maximum : `7300`	integer

4.2.2 - SecretVaultCreateResponse

Name	Description	Schema	Default
secret_vault required		SecretVaultKey

4.2.3 - SecretVaultDetailKey

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

4.2.4 - SecretVaultKey

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

4.2.5 - SecretVaultKeyListResponse

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

4.2.6 - SecretVaultListKey

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

4.2.7 - SecretVaultShowResponse

Name	Description	Schema	Default
secret_vault required		SecretVaultDetailKey

4.2.8 - SecretVaultTemporaryKeyResponse

Name	Description	Schema
access_key optional	삼성 클라우드 플랫폼 포털에서 발급받은 Access Key Example : `testname`	any of [string, null]
expired_at required	만료일 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
secret_key optional	Secret key Example : `testname`	any of [string, null]

4.2.9 - SecretVaultTerminatedRequest

Name	Description	Schema	Default
waiting_time_ndays required	삭제까지 남은 일수 Example : `7` Minimum : `7` Maximum : `30`	integer

4.2.10 - Tag

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

5 - Secrets Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Secrets Manager에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Version	Status	Supported Until
1.0	CURRENT	-

OpenAPI URL

https://secretsmanager.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

5.1 - APIs

5.1.1 - Create Secret

5.1.1.1 - 1.0

post /v1/secrets

Description

Secret 을 생성합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsManagerCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecretsManagerCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
    "description": "description",
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
    "name": "name",
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
    "tags": []
}

Example HTTP response

Response 201

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.2 - Delete Secret

5.1.2.1 - 1.0

delete /v1/secrets/{secret_id}

Description

Secret을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerTerminatedRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 204

5.1.3 - Generate Random Password

5.1.3.1 - 1.0

post /v1/secrets/random-password

Description

임의 비밀번호 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsRandomPasswordRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsRandomPasswordResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets/random-password

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "exclude_characters": "abcdefg",
    "exclude_lowercase": "false",
    "exclude_numbers": "false",
    "exclude_punctuation": "false",
    "exclude_uppercase": "false",
    "include_space": "false",
    "password_length": 32,
    "require_each_included_type": "true"
}

Example HTTP response

Response 200

{
    "random_password": "random-value"
}

5.1.4 - List Secrets

5.1.4.1 - 1.0

get /v1/secrets

Description

Secret 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Secret 이름 Example : `name`	any of [string, null]	None
query	state optional	Secret 상태 Example : `Active`	any of [array[string], null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secret": [
        {
            "account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "deleted_at": "2025-02-25 03:07:17.000",
            "description": "description",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
            "kms_name": "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": "Active",
            "type": "General"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.5 - List Versions of Secret

5.1.5.1 - 1.0

get /v1/secrets/{secret_id}/versions

Description

Secrets 버전 리스트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerVersionListResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "version_list": [
        ""
    ]
}

5.1.6 - Restore Secret

5.1.6.1 - 1.0

put /v1/secrets/{secret_id}/restore

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.7 - Set CIDR of Secret

5.1.7.1 - 1.0

put /v1/secrets/{secret_id}/acl-cidr

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetCidrRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/acl-cidr

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.8 - Set Description of Secret

5.1.8.1 - 1.0

put /v1/secrets/{secret_id}/description

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.9 - Set KMS ID of Secret

5.1.9.1 - 1.0

put /v1/secrets/{secret_id}/kmsid

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetKmsRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/kmsid

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.10 - Set Label of Version

5.1.10.1 - 1.0

put /v1/secrets/{secret_id}/label

Description

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

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerUpdateLabelRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/label

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "My Custom Label",
    "move_to_version_id": "3265ab469f0d406d83073da3e11e7a6c",
    "remove_from_version_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

5.1.11 - Show Secret Detail

5.1.11.1 - 1.0

get /v1/secrets/{secret_id}

Description

Secret 상세정보 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.1.12 - Show Secret Value

5.1.12.1 - 1.0

post /v1/secrets/{secret_id}/values

Description

Secret value 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerShowSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowSecretValueResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "CURRENT",
    "version_id": "e7b638507d9f4feeb6032a22b7640bf7"
}

Example HTTP response

Response 200

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

5.1.13 - Update Secret Value

5.1.13.1 - 1.0

put /v1/secrets/{secret_id}/values

Description

Secret value 업데이트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "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": "Active",
        "type": "General"
    }
}

5.2 - Models

5.2.1 - SecretsManager

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

5.2.2 - SecretsManagerCreateRequest

Name	Description	Schema
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	string
description optional	Secret 설명 Example : `description`	any of [string, null]
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
name required	Secret 이름 Example : `name` Pattern : `^[A-Za-z0-9_-]$` Minimum length* : `3` Maximum length : `63`	string
secret_value required	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. Example : `{"key1":"value1","key2":"value2"}`	string
tags optional	태그 리스트	any of [array[Tag], null]

5.2.3 - SecretsManagerCreateResponse

Name	Description	Schema	Default
secret required		SecretsManager

5.2.4 - SecretsManagerListResponse

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

5.2.5 - SecretsManagerSetCidrRequest

Name	Description	Schema	Default
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]

5.2.6 - SecretsManagerSetDescriptionRequest

Name	Description	Schema	Default
description required	Secret 설명 Example : `description`	any of [string, null]

5.2.7 - SecretsManagerSetKmsRequest

Name	Description	Schema	Default
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string

5.2.8 - SecretsManagerSetSecretValueRequest

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

5.2.9 - SecretsManagerShowResponse

Name	Description	Schema	Default
secret required		SecretsManager

5.2.10 - SecretsManagerShowSecretValueRequest

Name	Description	Schema	Default
label optional	Secret 버전 라벨. 중복 불가. Example : `CURRENT` Minimum length : `1` Maximum length : `256`	string
version_id optional	Secret 버전 아이디 Example : `e7b638507d9f4feeb6032a22b7640bf7`	string

5.2.11 - SecretsManagerShowSecretValueResponse

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

5.2.12 - SecretsManagerTerminatedRequest

Name	Description	Schema	Default
waiting_time_ndays required	삭제까지 남은 일수 Example : `7` Minimum : `7` Maximum : `30`	integer

5.2.13 - SecretsManagerUpdateLabelRequest

Name	Description	Schema
label required	Secret 버전 라벨. 중복 불가. Example : `My Custom Label` Minimum length : `1` Maximum length : `256`	string
move_to_version_id optional	Secret 버전 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	any of [string, null]
remove_from_version_id optional	Secret 버전 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	any of [string, null]

5.2.14 - SecretsManagerVersionListResponse

Name	Description	Schema	Default
version_list required		array[object]

5.2.15 - SecretsRandomPasswordRequest

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

5.2.16 - SecretsRandomPasswordResponse

Name	Description	Schema	Default
random_password required	임의 비밀번호 생성 Example : `random-value`	string

5.2.17 - Tag

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