This is the multi-page printable view of this section. Click here to print.
Models
- 1: CertificateCreate
- 2: CertificateCreateRequest
- 3: CertificateCreateResponse
- 4: CertificateDetail
- 5: CertificateDetailResponse
- 6: CertificateDetailResponseV1Dot2
- 7: CertificateDetailV1Dot2
- 8: CertificateDuplicateRequest
- 9: CertificateList
- 10: CertificateListResponse
- 11: CertificateValidateRequest
- 12: CertificateValidateRequestV1Dot1
- 13: CertificateValidateResponseV1Dot1
- 14: CheckResponse
- 15: Recipient
- 16: SelfSignCreateRequest
- 17: Tag
1 - CertificateCreate
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : b82909b3576449fda984fb25c3123542da | string | |
| cert_body required | Certificate body Example : | string | |
| cert_chain optional | Certificate chain Example : | any of [string, null] | |
| cert_kind optional | Certificate type Example : PRD | string | |
| cert_type required | Certificate type Example : pem | string | |
| cert_version required | Certificate Version Example : 2 | string | |
| cn required | Certificate Common Name Example : test.go.kr | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| key_bit_size required | key bits size Example : 2048 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Certificate Name Example : test-certificate | string | |
| not_after_dt required | Certificate Expire Date Example : 2026-02-07T18:07:59 | string (date-time) | |
| not_before_dt required | Certificate Start Date Example : 2025-02-08T18:07:00 | string (date-time) | |
| organization required | Certificate Organization Name Example : samsungSDS | string | |
| private_key required | Private key Example : | string | |
| recipients optional | Expired certificates Recipients Example : [{'region': '', 'user_id': 'sdaFDQSDADZ2488e195c0e97d9b9eb', 'user_name': 'kildong.hong'}] | array[Recipient] | |
| state required | Certificate State Example : VALID | string | |
| tags optional | Tag List’ | array[Tag] | |
| user_name required | User Name Example : kildong@samsung.com | string |
2 - CertificateCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cert_body required | Certificate body Example : <encoded certificate body data> | string | |
| cert_chain optional | Certificate chain Example : <encoded certificate chain data> | any of [string, null] | |
| name required | Certificate Name Example : test-certificate | string | |
| private_key required | Private key Example : <encoded private_key data> | string | |
| recipients optional | Expired certificates Recipients Example : [{'region': '', 'user_id': 'sdaFDQSDADZ2488e195c0e97d9b9eb', 'user_name': 'kildong.hong'}] | array[Recipient] | |
| region required | Name of region Example : west1 | string | |
| tags optional | Tag List’ | array[Tag] | |
| timezone required | Timezone Example : Asia/Seoul | string |
3 - CertificateCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| certificate required | CertificateCreate |
4 - CertificateDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : b82909b3576449fda984fb25c3123542da | string | |
| cert_body required | Certificate body Example : | string | |
| cert_chain optional | Certificate chain Example : | any of [string, null] | |
| cert_kind optional | Certificate type Example : DEV | string | |
| cert_type required | Certificate type Example : pem | string | |
| cert_version required | Certificate Version Example : 2 | string | |
| cn required | Certificate Common Name Example : test.go.kr | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| key_bit_size required | key bits size Example : 2048 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Certificate Name Example : test-certificate | string | |
| not_after_dt required | Certificate Expire Date Example : 2026-02-07T18:07:59 | string (date-time) | |
| not_before_dt required | Certificate Start Date Example : 2025-02-08T18:07:00 | string (date-time) | |
| organization required | Certificate Organization Name Example : samsungSDS | string | |
| private_key required | Private key Example : | string | |
| state required | Certificate State Example : VALID | string | |
| user_name required | User Name Example : 2048 | string |
5 - CertificateDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| certificate required | CertificateDetail |
6 - CertificateDetailResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| certificate required | CertificateDetailV1Dot2 |
7 - CertificateDetailV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : b82909b3576449fda984fb25c3123542da | string | |
| cert_body required | Certificate body Example : | string | |
| cert_chain optional | Certificate chain Example : | any of [string, null] | |
| cert_kind optional | Certificate type Example : DEV | string | |
| cert_type required | Certificate type Example : pem | string | |
| cert_version required | Certificate Version Example : 2 | string | |
| cn required | Certificate Common Name Example : test.go.kr | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| days_until_expiration required | Days Until Expiration Example : 830 | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| is_in_use required | In Use Example : is in use | boolean | |
| issuer optional | Issuer Example : MyInternalSubCA | any of [string, null] | |
| key_bit_size required | key bits size Example : 2048 | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | Certificate Name Example : test-certificate | string | |
| not_after_dt required | Certificate Expire Date Example : 2026-02-07T18:07:59 | string (date-time) | |
| not_before_dt required | Certificate Start Date Example : 2025-02-08T18:07:00 | string (date-time) | |
| organization required | Certificate Organization Name Example : samsungSDS | string | |
| private_key required | Private key Example : | string | |
| public_key_bit_size optional | Public Key Bit Size Example : public key bit size | any of [string, null] | |
| public_key_type optional | Public Key Type Example : public key type | any of [string, null] | |
| signature_algorithm optional | Signature Algorithm Example : signature algorithm | any of [string, null] | |
| state required | Certificate State Example : VALID | string | |
| sub_domain optional | Sub Domain Example : api-guard.dev | any of [string, null] | |
| user_name required | User Name Example : kildong@samsung.com | string |
8 - CertificateDuplicateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Certificate Name Example : | string |
9 - CertificateList
| Name | Description | Schema | Default |
|---|---|---|---|
| cert_kind optional | Certificate type Example : PRD | string | |
| cn required | Certificate Common Name Example : test.go.kr | string | |
| id required | Certificate ID Example : | string | |
| name required | Certificate Name Example : test-certificate | string | |
| not_after_dt required | Certificate Expire Date Example : 2026-02-07T18:07:59 | string (date-time) | |
| not_before_dt required | Certificate Start Date Example : 2025-02-08T18:07:00 | string (date-time) | |
| state required | Certificate State Example : VALID | string |
10 - CertificateListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
11 - CertificateValidateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cert_body required | Certificate body Example : <encoded certificate body data> | string | |
| cert_chain optional | Certificate chain Example : <encoded certificate chain data> | any of [string, null] | |
| is_need_cert_chain required | Is needed Certificate chain Example : True | boolean | |
| private_key required | Private key Example : <encoded private_key data> | string |
12 - CertificateValidateRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| cert_body required | Certificate body Example : <encoded certificate body data> | string | |
| cert_chain optional | Certificate chain Example : <encoded certificate chain data> | any of [string, null] | |
| private_key required | Private key Example : <encoded private_key data> | string |
13 - CertificateValidateResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| validate_check required | Example : | boolean |
14 - CheckResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | True, False Check Example : True | boolean |
15 - Recipient
| Name | Description | Schema | Default |
|---|---|---|---|
| region required | Name of region Example : | string | |
| user_id required | User ID Example : | string | |
| user_name required | User Name Example : | string |
16 - SelfSignCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| cn required | Certificate Common Name Example : test.go.kr | string | |
| name required | Certificate Name Example : test-certificate | string | |
| not_after_dt required | Certificate Expire Date Example : 20251212 | string | |
| not_before_dt required | Certificate Start Date Example : 20250101 | string | |
| organization required | Certificate Organization Name Example : samsungSDS | string | |
| recipients optional | Expired certificates Recipients | array[Recipient] | |
| region required | Name of region Example : west1 | string | |
| tags optional | Tag List’ | array[Tag] | |
| timezone required | Timezone Example : Asia/Seoul | string |
17 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | tag key Example : | string | |
| value required | tag value Example : | string |