Classic/VPC環境で利用できます。
Private CAは、標準に基づいたプライベート認証局(Certificate Authority、CA)の構築と運用をサポートし、プライベート証明書を安全に発行、管理、失効させる機能を提供する NAVERクラウドプラットフォームのサービスです。Private CAサービスではプライベート認証局(CA)を運用し、プライベート証明書の発行・管理機能に関する APIを RESTful形式で提供します。
Private CAの共通設定
Private CA APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://pca.apigw.ntruss.com/api/v1
リクエストヘッダ
ヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒) |
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key |
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 |
Content-type |
Required | リクエストデータの形式application/json |
レスポンス
共通レスポンス形式を説明します。
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 400 | - | 無効なリクエストです。 | リクエスト構文エラー |
| 400 | - | ncloudInstanceNoが抜けています。 | ncloudInstanceNoが入力されていない |
| 400 | - | tenant idが抜けています。 | tenant idが入力されていない |
| 400 | - | idNoが抜けています。 | idNoが入力されていない |
| 400 | - | aliasが抜けています。 | aliasが入力されていない |
| 400 | - | common nameが抜けています。 | x509Parameters.commonNameが入力されていない |
| 400 | - | x509Parametersが抜けています。 | 高度な設定情報(x509Parameters)が入力されていない |
| 400 | - | csrが抜けています。 | csrPemが入力されていない |
| 400 | - | certが抜けています。 | certPemが入力されていない |
| 400 | - | statusが抜けています。 | statusが入力されていない |
| 400 | - | caIdが抜けています。 | caIdが入力されていない |
| 400 | - | serial noが抜けています。 | serialNoが入力されていない |
| 400 | - | tokenが抜けています。 | トークンの値が入力されていない |
| 400 | - | ca typeが抜けています。 | caTypeが入力されていない |
| 400 | - | key bitsが抜けています。 | Key Bitsが入力されていない |
| 400 | - | request bodyが抜けています。 | リクエストボディが入力されていない |
| 400 | - | caTagが抜けています。 | caTagが入力されていない |
| 400 | - | caIdまたは caTagが抜けています。 | caIdまたはcaTagが入力されていない |
| 400 | - | chainが抜けています。 | caChainが入力されていない |
| 400 | - | expiryが抜けています。 | expiryが入力されていない |
| 400 | - | ocsp_serversが抜けています。 | ocsp_serversが入力されていない |
| 400 | - | 無効な入力値です。 | 無効なリクエストを入力 |
| 400 | - | 無効な certificateです。 | 入力されたcertificateが無効である |
| 400 | - | 無効な statusです。 | 入力されたstatusが無効である |
| 400 | - | 無効な periodです。 | 入力されたperiodが無効である |
| 400 | - | 無効な page noです。 | 入力されたpageNoが無効である |
| 400 | - | 無効な serial noです。 | 入力されたserialNoが無効である |
| 400 | - | ca aliasが最大長さを超えています。 | 入力されたaliasが最大長さを超過 |
| 400 | - | memoが最大長さを超えています。 | 入力されたdescriptionが最大長さを超過 |
| 400 | - | common nameが最大長さを超えています。 | 入力されたx509Parameters.commonNameが最大長さを超過 |
| 400 | - | organizationが最大長さを超えています。 | 入力されたx509Parameters.organizationが最大長さを超過 |
| 400 | - | organization unitが最大長さを超えています。 | 入力されたx509Parameters.organicationUnitが最大長さを超過 |
| 400 | - | state provinceが最大長さを超えています。 | 入力されたx509Parameters.stateProvinceが最大長さを超過 |
| 400 | - | localityが最大長さを超えています。 | 入力されたx509Parameters.localityが最大長さを超過 |
| 400 | - | street addressが最大長さを超えています。 | 入力されたx509Parameters.streetAddressが最大長さを超過 |
| 400 | - | サポートしない keyBitsです。 | 無効な Key Bitsを入力 |
| 400 | - | 無効な keyTypeです。 | 入力されたkeyTypeが無効である |
| 400 | - | 無効な caIdです。 | 入力されたcaIdが無効である |
| 400 | - | 無効な csrです。 | 入力されたcsrPemが無効である |
| 400 | - | 無効な tenant idです。 | 入力された tenant idが無効である |
| 400 | - | 無効な id noです。 | 入力されたidNoが無効である |
| 400 | - | 無効な userです。 | 入力された userが無効である |
| 400 | - | 無効な key typeです。 | 入力されたキータイプが無効である |
| 400 | - | 無効な IPアドレスです。 | 入力されたx509Parameters.ipが無効である |
| 400 | - | 無効な uriです。 | 入力された URIが無効である |
| 400 | - | 無効な otherです。 | 入力された otherが無効である |
| 400 | - | 証明書を検証できません。無効な ca chainです。 | 入力されたcaChainが無効である |
| 400 | - | CA証明書は失効させることができません。 | 無効な失効リクエスト |
| 400 | - | CSRの keyBitsとリクエストボディの keyBitsが一致しません。 | CSRの Key Bitsとリクエストボディの Key Bitsが一致しない |
| 400 | - | CSRの keyTypeとリクエストボディの keyTypeが一致しません。 | CSRのキータイプとリクエストボディに入力されたキータイプが一致しない |
| 400 | - | 無効な状態です。 | 無効な状態 |
| 400 | - | 無効な castoreです。 | 無効な castore |
| 400 | - | caの状態が無効です。 | 無効な CAの状態 |
| 400 | - | issuer caの状態が無効です。 | 無効な issuer caの状態 |
| 400 | - | 無効な caです。 | 無効な CA |
| 400 | - | 無効な ca typeです。 | 入力されたcaTypeが無効である |
| 400 | - | 無効な certです。 | 入力されたcertが無効である |
| 400 | - | 発行可能な最大数を超えています。 発行可能な証明書は30,000までです。 追加発行が必要な場合はサポートセンターにお問い合わせください。 |
発行可能な証明書数超過 |
| 400 | - | ca有効期限を超えています。 | CSRの有効期限が CAの有効期限を超過 |
| 400 | - | 作成可能な最大 ca数を超えています。 ルート/中間 caは10個まで作成できます。 |
作成可能な CA数超過 |
| 400 | - | 既に存在する castoreです。 | 使用中の castoreが入力される |
| 400 | - | 既に存在する aliasです。 | 使用中の CA名が入力される |
| 400 | - | 既に存在する policyです。 | 使用中の policyが入力される |
| 400 | - | 既に有効期限切れの certです。 | 期限切れとなった証明書情報が入力される |
| 400 | - | castoreが存在しません。 | 存在しない castoreを入力 |
| 400 | - | policyが存在しません。 | 存在しない policyを入力 |
| 400 | - | crl configurationが存在しません。 | CRL更新周期が設定されていない |
| 400 | - | CAが存在しません。 | 存在しない CAを入力 |
| 400 | - | 証明書が存在しません。 | 存在しない証明書を入力 |
| 500 | - | ご不便をおかけして申し訳ございません。サービスが一時的に利用できません。エラーが続く場合は、カスタマーサポートまでお問い合わせください。 | サービスエラー |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Private CA API
Private CAサービスで提供する APIの説明は次の通りです。
| API | 説明 |
|---|---|
| Activate Sub CA | 中間 CAを有効化 |
| Create CA | CAを作成 |
| Create OCSP | OCSP URLをプライベート証明書にバインド |
| Delete CA | CAを削除 |
| Delete OCSP | プライベート証明書から OCSP URLを削除 |
| Get CA | CAの詳細情報を照会 |
| Get CA Chain | CAチェーン情報を照会 |
| Get CA CRL | CA CRLを照会 |
| Get CA List | CAの全リストを照会 |
| Get CRL Config | CA CRLの更新周期を照会 |
| Get End Cert | プライベート証明書の詳細情報を照会 |
| Get End Cert List | プライベート証明書の全リストを照会 |
| Get Sub CSR | 中間 CAの CSRを照会 |
| Issue End Cert | Private証明書の発行 |
| Revoke End Cert | プライベート証明書の失効 |
| Rotate CRL | CRL手動ローテーションで更新 |
| Sign End Csr | CSRで新しい証明書に署名 |
| Sign Sub Csr | 中間 CA証明書を発行 |
| Trim CA | 期限切れになった証明書を削除して CRLを整理 |
| Update CA | CAの状態を変更 |
| Update CRL Config | CA CRLの更新周期を設定 |
Private CA関連リソース
Private CA APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Private CA APIの使用方法
- Sub Accountご利用ガイド: NAVERクラウドプラットフォームコンソールから発行されたサブアカウントの Access Key発行と確認方法
- 署名(シグネチャー)の作成: リクエストヘッダに必要な署名の作成方法
- Ncloudの共通レスポンスステータスコード: Private CAサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Private CAサービスの使用方法
- Private CAご利用ガイド: NAVERクラウドプラットフォームコンソールで Private CAを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポート有無に関するガイド
- 料金の紹介、特徴、詳細機能: Private CAの料金体系、特徴、詳細機能のサマリー
- サービスのお知らせ: Private CA関連の最新共有ニュース
- よくある質問: Private CAに関するよくあるご質問
- お問い合わせ: ご利用ガイドだけでは不明な点が解消されない場合、直接お問い合わせ