Update CA

Prev Next

Classic/VPC環境で利用できます。

CAの状態を変更します。

リクエスト

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

メソッド URI
PUT /ca/{caTag}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
caTag String Required CAタグ

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
status String Required CAの状態
  • ACTIVE | DEACTIVATED | DESTROYING
    • ACTIVE: 有効化
    • DEACTIVATED: 無効化
    • DESTROYING: 削除予定
注意

状態をDESTROYINGに変更すると、72時間の削除待ち時間が経過した後、自動的にその CAと下位 CAが削除されます。この過程で、CAが発行した証明書の運用状態や有効期限が切れているかどうかは考慮されません。一度削除した CAの秘密鍵は完全に削除され復旧できません。CAの削除は慎重に行ってください。さらに、削除された CAはその後信頼されなくなり、その CAが発行したすべての証明書は認証目的で使用できません。

リクエスト例

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

curl --location --request PUT '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' \
--data '{
    "status": "DESTROYING"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
msg String - レスポンスメッセージ
data Object - レスポンス結果
data.caInfo Object - CA情報
data.caInfo.signingCount Number - CAで署名した証明書の数
data.caInfo.caType String - CAタイプ
  • PRIVATE_ROOT | PRIVATE_SUB
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の状態
  • ACTIVE | DEACTIVATED | DESTROYING
    • ACTIVE: 有効化
    • DEACTIVATED: 無効化
    • DESTROYING: 削除予定

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "msg": "Success",
    "data": {
        "signingCount": 0,
        "caType": "PRIVATE_ROOT",
        "caId": 17***,
        "statusUpdateDate": 1721106009601,
        "destroyDate": 1721368800000,
        "alias": "CA002",
        "memo": "",
        "urlInfo": {
            "ocsp": [],
            "crl": [
                "https://pca.apigw.ntruss.com/ext/********-********/crl"
            ],
            "ca": [
                "https://pca.apigw.ntruss.com/ext/********-********/ca"
            ]
        },
        "caTag": "********-********",
        "rgstDate": 1721105599000,
        "status": "DESTROYING"
    }
}