PrivateCA概要

概要

PrivateCA APIはRESTfulの形で提供されます。PrivateCA Rest APIを呼び出すには、API GatewayとSub Account認証を行わなければなりません。

API Gatewayを通じたAPI呼び出しに関しては、API Gateway説明書(旧ユーザーガイド) を参照してください。APIリクエストメッセージは、以下のように構成されます。

リクエスト構成

Header
  x-ncp-apigw-timestamp:{Timestamp}
  x-ncp-iam-access-key:{Sub Account Access Key}
  x-ncp-apigw-signature-v2:{API Gateway Signature}
  Content-Type:application/json
Body

URL
  https://pca.apigw.ntruss.com/api/v1/ca/{caTag}/{url}

例

リクエスト例

curl -i -s -X GET \
-H "x-ncp-apigw-timestamp:1598425115345" \
-H "x-ncp-iam-access-key:3A03131E1348C83101" \
-H "x-ncp-apigw-signature-v2:FkL1mw12345678DRu9R50tdGSyc/uQ/oTw=" \
-H "Content-Type:application/json" \
'https://pca.apigw.ntruss.com/api/v1/ca/4b0bbe37-eeea93b8'

レスポンス例

{
    "code": "SUCCESS",
    "msg": "Success",
    "data": {
        "caInfo": {
            "signingCount": 0,
            "caType": "PRIVATE_ROOT",
            "caId": 1,
            "statusUpdateDate": null,
            "destroyDate": null,
            "alias": "portal_root_ca",
            "memo": "company portal root ca",
            "urlInfo": {
                "ocsp": [],
                "crl": [
                    "https://pca.apigw.ntruss.com/ext/4b0bbe37-eeea93b8/crl"
                ],
                "ca": [
                    "https://pca.apigw.ntruss.com/ext/4b0bbe37-eeea93b8/ca"
                ]
            },
            "caTag": "4b0bbe37-eeea93b8",
            "rgstDate": 1597122400000,
            "status": "ACTIVE"
        },
        "caCertInfo": {
            "commonName": "*.portal.com",
            "country": "KR",
            "issuerName": "*.portal.com",
            "notAfterDate": 1912482399000,
            "publicKeyAlgorithm": "RSA",
            "notBeforeDate": 1597122370000,
            "locality": "Seoul",
            "stateProvince": "Gangnam gu",
            "organizationUnit": "Service Develop Unit",
            "certPem": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
            "chainPem": "",
            "signatureAlgorithm": "SHA256withRSA",
            "serialNo": "2a:8e:c7:3b:f3:2b:50:f3:fd:e5:4f:23:b6:3a:ee:50:63:1a:fd:77",
            "caCertId": 1,
            "organization": "my company"
        }
    }
}

エラーコード