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

Return to the regular view of this page.

Certificate Manager

Overview

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

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

Version

VersionStatusSupported Until
1.0SUPPORTED20260531
1.1CURRENT-

1 - CLIs

1.1 - Check duplicate name

1.1.1 - 1.1

scpcli certificatemanager certificate check
--name <value>

Description

Check duplication name

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.1.2 - 1.0

scpcli certificatemanager certificate check
--name <value>

Description

Check duplication name

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
name
required
stringCertificate Name-

Responses

NameDescriptionExample
resultTrue, False CheckTrue

1.2 - Create a certificate

1.2.1 - 1.1

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

Description

Create a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

Responses

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

1.2.2 - 1.0

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

Description

Create a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

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

Responses

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

1.3 - Delete a certificate

1.3.1 - 1.1

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

1.3.2 - 1.0

scpcli certificatemanager certificate delete
--certificate_id <value>

Description

Delete a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

1.4 - Detail a certificate

1.4.1 - 1.1

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

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

1.4.2 - 1.0

scpcli certificatemanager certificate detail
--certificate_id <value>

Description

Detail a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

NameTypeDescriptionExample
certificate_id
required
stringCertificate ID-

Responses

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

1.5 - List certificates

1.5.1 - 1.1

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

Description

List Certificates

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

Responses

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

1.5.2 - 1.0

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

Description

List Certificates

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

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

Responses

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

1.6 - Self-sign a certificate

1.6.1 - 1.1

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

Description

Self-sign a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

Responses

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

1.6.2 - 1.0

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

Description

Self-sign a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

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

Responses

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

1.7 - Validate a certificate

1.7.1 - 1.1

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

Description

Validate a Certificate

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

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

Responses

NameDescriptionExample
validate_check

1.7.2 - 1.0

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

Description

Validate a Certificate

State ACTIVE (SUPPORTED)

VersionSupported Until
1.020260531

Parameters

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

Responses

NameDescriptionExample
resultTrue, False CheckTrue