リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/ca

リクエストヘッダ

Private CA APIで共通して使用されるヘッダの詳細は、Private CAの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Long	Optional	ページ番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://pca.apigw.ntruss.com/api/v1/ca' \
--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'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	レスポンスコード
`msg`	String	-	レスポンスメッセージ
`data`	Object	-	レスポンス結果
`data.totalCnt`	Long	-	レスポンス結果数
`data.caInfoList`	Array	-	CA情報リスト
`data.totalPageNo`	Long	-	総ページ番号
`data.currentPageNo`	Long	-	現在のページ番号

`caInfoList`

caInfoListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`caInfo`	Object	-	CA情報
`caInfo.signingCount`	Long	-	CAで署名した証明書の数
`caInfo.caType`	String	-	CAタイプ `PRIVATE_ROOT` \| `PRIVATE_SUB`
`caInfo.caId`	Long	-	CA識別子
`caInfo.statusUpdateDate`	String	-	最終状態更新日時(Timestamp)
`caInfo.destroyDate`	String	-	削除日時(Timestamp)
`caInfo.alias`	String	-	CA名
`caInfo.memo`	String	-	CAメモ
`caInfo.nrn`	String	-	CAの識別値 NRN(Ncloud Resource Names): NAVERクラウドプラットフォームリソースの命名ルール(Naming Rule)
`caInfo.urlInfo`	Object	-	URL情報
`caInfo.urlInfo.ocsp`	Array	-	OCSP(オンライン証明書状態プロトコル) URL
`caInfo.urlInfo.crl`	Array	-	CRL(証明書失効リスト) URL
`caInfo.urlInfo.ca`	Array	-	CA URL
`caInfo.caTag`	String	-	CAタグ
`caInfo.rgstDate`	Number	-	登録日時(Timestamp)
`caInfo.status`	String	-	CAの状態 `ACTIVE` \| `DEACTIVATED` \| `DESTROYING` `ACTIVE`: 有効化 `DEACTIVATED`: 無効化 `DESTROYING`: 削除予定
`caCertInfo`	Object	-	CA証明書情報
`caCertInfo.commonName`	String	-	一般名
`caCertInfo.contry`	String	-	標準国コード ISO 3166-1 alpha-2を参照
`caCertInfo.issueName`	String	-	発行 CA名
`caCertInfo.notAfterDate`	Long	-	証明書の期限切れ日時(Timestamp)
`caCertInfo.publicKeyAlgorithm`	String	-	暗号化アルゴリズム
`caCertInfo.notBeforeDate`	Long	-	証明書の有効開始日時(Timestamp)
`caCertInfo.locality`	String	-	都市名
`caCertInfo.stateProvince`	String	-	州/道または地域名
`caCertInfo.organicationUnit`	String	-	部署名
`caCertInfo.certPem`	String	-	CA証明書(PEM)
`caCertInfo.chainPem`	String	-	証明書チェーン(PEM)
`caCertInfo.signatureAlgorithm`	String	-	署名アルゴリズム
`caCertInfo.serialNo`	String	-	証明書のシリアル番号
`caCertInfo.caCertId`	Long	-	証明書の識別子
`caCertInfo.organization`	String	-	組織名

レスポンスステータスコード

Private CA APIで共通して使用されるレスポンスステータスコードの詳細は、Private CAのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "SUCCESS",
    "msg": "Success",
    "data": {
        "totalCnt": 3,
        "caInfoList": [
            {
                "caInfo": {
                    "signingCount": 0,
                    "caType": "PRIVATE_ROOT",
                    "caId": 17***,
                    "statusUpdateDate": null,
                    "destroyDate": null,
                    "alias": "CA001",
                    "nrn":"nrn:PUB:PrivateCA::****:CA/****",
                    "memo": "",
                    "urlInfo": {
                        "ocsp": [],
                        "crl": [
                            "https://pca.apigw.ntruss.com/ext/********-********/crl"
                        ],
                        "ca": [
                            "https://pca.apigw.ntruss.com/ext/********-********/ca"
                        ]
                    },
                    "caTag": "********-********",
                    "rgstDate": 1721105242000,
                    "status": "ACTIVE"
                },
                "caCertInfo": {
                    "commonName": "name001",
                    "country": "",
                    "issuerName": "name001",
                    "notAfterDate": 2036465242000,
                    "publicKeyAlgorithm": "RSA",
                    "notBeforeDate": 1721105212000,
                    "locality": "",
                    "stateProvince": "",
                    "organizationUnit": "",
                    "certPem": "-----BEGIN CERTIFICATE-----\n{Certificate}\n-----END CERTIFICATE-----",
                    "chainPem": "-----BEGIN CERTIFICATE-----\n{CA Chain}\n-----END CERTIFICATE-----",
                    "signatureAlgorithm": "SHA256withRSA",
                    "serialNo": "**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**:**",
                    "caCertId": 17***,
                    "organization": ""
                }
            },
            {
                "caInfo": {
                    "signingCount": 0,
                    "caType": "PRIVATE_SUB",
                    "caId": 17***,
                    "statusUpdateDate": null,
                    "destroyDate": null,
                    "alias": "CA000",
                    "nrn":"nrn:PUB:PrivateCA::****:CA/****",
                    "memo": "",
                    "urlInfo": {
                        "ocsp": [],
                        "crl": [],
                        "ca": []
                    },
                    "caTag": "********-********",
                    "rgstDate": 1721105063000,
                    "status": "PENDING"
                },
                "caCertInfo": {
                    "commonName": "name000",
                    "country": null,
                    "issuerName": null,
                    "notAfterDate": null,
                    "publicKeyAlgorithm": null,
                    "notBeforeDate": null,
                    "locality": null,
                    "stateProvince": null,
                    "organizationUnit": null,
                    "certPem": "-----BEGIN CERTIFICATE REQUEST-----\n{Certificate}\n-----END CERTIFICATE REQUEST-----",
                    "chainPem": null,
                    "signatureAlgorithm": null,
                    "serialNo": null,
                    "caCertId": 17***,
                    "organization": null
                }
            },
            {
                "caInfo": {
                    "signingCount": 0,
                    "caType": "PRIVATE_SUB",
                    "caId": 17***,
                    "statusUpdateDate": null,
                    "destroyDate": null,
                    "alias": "CA123",
                    "nrn":"nrn:PUB:PrivateCA::****:CA/****",
                    "memo": "",
                    "urlInfo": {
                        "ocsp": [],
                        "crl": [],
                        "ca": []
                    },
                    "caTag": "********-********",
                    "rgstDate": 1721104975000,
                    "status": "PENDING"
                },
                "caCertInfo": {
                    "commonName": "name000",
                    "country": "KOR",
                    "issuerName": null,
                    "notAfterDate": null,
                    "publicKeyAlgorithm": null,
                    "notBeforeDate": null,
                    "locality": "Pangyo",
                    "stateProvince": "Seongnam-si",
                    "organizationUnit": "org001",
                    "certPem": "-----BEGIN CERTIFICATE REQUEST-----\n{Certificate}\n-----END CERTIFICATE REQUEST-----",
                    "chainPem": null,
                    "signatureAlgorithm": null,
                    "serialNo": null,
                    "caCertId": 17***,
                    "organization": "org000"
                }
            }
        ],
        "totalPageNo": 1,
        "currentPageNo": 1
    }
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Private CA