Classic/VPC環境で利用できます。
署名された証明書と CAの証明書を使用して、直接署名方式で中間 Certificate Authority(CA)を有効化します。
注意
発行 CAの証明書は CAの秘密鍵でないことにご注意ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /ca/{caTag}/activate |
リクエストヘッダ
Private CA APIで共通して使用されるヘッダの詳細は、Private CAの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
caTag |
String | Required | CAタグ
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
certPem |
String | Required | CA証明書(PEM)
|
caChainPem |
String | Required | 署名者証明書チェーン(PEM)
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://pca.apigw.ntruss.com/api/v1/ca/*********-*********/activate' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"certPem": "-----BEGIN CERTIFICATE-----\n{Certificate}\n-----END CERTIFICATE-----",
"caChainPem": "-----BEGIN CERTIFICATE-----\n{CA Chain}\n-----END CERTIFICATE-----"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
code |
String | - | レスポンスコード |
msg |
String | - | レスポンスメッセージ |
data |
Object | - | レスポンス結果 |
data.caInfo |
Object | - | CA情報 |
data.caInfo.signingCount |
Number | - | CAで署名した証明書の数 |
data.caInfo.caType |
String | - | CAタイプ
|
data.caInfo.caId |
Number | - | CA識別子 |
data.caInfo.statusUpdateDate |
String | - | 最終状態更新日時(Timestamp) |
data.destroyDate |
String | - | 削除日時(Timestamp) |
data.caInfo.alias |
String | - | CA名 |
data.caInfo.memo |
String | - | CAメモ |
data.caInfo.urlInfo |
Object | - | URL情報 |
data.caInfo.urlInfo.ocsp |
Array | - | OCSP(オンライン証明書状態プロトコル) URL |
data.caInfo.urlInfo.crl |
Array | - | CRL(証明書失効リスト) URL |
data.caInfo.urlInfo.ca |
Array | - | CA URL |
data.caTag |
String | - | CAのタグ |
data.rgstDate |
Number | - | 登録日時(Timestamp) |
data.status |
String | - | CAの状態
|
data.caCertInfo |
Object | - | CA証明書情報 |
data.caCertInfo.commonName |
String | - | 一般名 |
data.caCertInfo.contry |
String | - | 標準国コード |
data.caCertInfo.issueName |
String | - | 発行 CA名 |
data.caCertInfo.notAfterDate |
Long | - | 証明書の期限切れ日時(Timestamp) |
data.caCertInfo.publicKeyAlgorithm |
String | - | 暗号化アルゴリズム |
data.caCertInfo.notBeforeDate |
Long | - | 証明書の有効開始日時(Timestamp) |
data.caCertInfo.locality |
String | - | 都市名 |
data.caCertInfo.stateProvince |
String | - | 州/道または地域名 |
data.caCertInfo.organicationUnit |
String | - | 部署名 |
data.caCertInfo.certPem |
String | - | CA証明書(PEM) |
data.caCertInfo.chainPem |
String | - | 証明書チェーン(PEM) |
data.caCertInfo.signatureAlgorithm |
String | - | 署名アルゴリズム |
data.caCertInfo.serialNo |
String | - | 証明書のシリアル番号 |
data.caCertInfo.caCertId |
Long | - | 証明書の識別子 |
data.caCertInfo.organization |
String | - | 組織名 |
レスポンスステータスコード
Private CA APIで共通して使用されるレスポンスステータスコードの詳細は、Private CAのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "SUCCESS",
"msg": "Success",
"data": {
"caInfo": {
"signingCount": 0,
"caType": "PRIVATE_SUB",
"caId": 18***,
"statusUpdateDate": null,
"destroyDate": null,
"alias": "caca002",
"memo": "",
"urlInfo": {
"ocsp": [],
"crl": [
"https://pca.apigw.ntruss.com/ext/*********-*********/crl"
],
"ca": [
"https://pca.apigw.ntruss.com/ext/*********-*********/ca"
]
},
"caTag": "*********-*********",
"rgstDate": 1723101003000,
"status": "PENDING"
},
"caCertInfo": {
"commonName": "name000",
"country": "KR",
"issuerName": "RootCA",
"notAfterDate": 1754637093000,
"publicKeyAlgorithm": "RSA",
"notBeforeDate": 1723101093000,
"locality": "Pangyo",
"stateProvince": "Seongnam-si",
"organizationUnit": "unit000",
"certPem": "-----BEGIN CERTIFICATE-----\n{Certificate}\n-----END CERTIFICATE-----",
"chainPem": "-----BEGIN CERTIFICATE-----\n{CA Chain}\n-----END CERTIFICATE-----",
"signatureAlgorithm": "SHA256withRSA",
"serialNo": "**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**",
"caCertId": 18173,
"organization": "org000"
}
}
}