Trust Anchorの更新

Prev Next

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

Trust Anchor情報を更新します。

リクエスト

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

メソッド URI
PATCH /api/v1/trust-anchors/{trustAnchorId}

リクエストヘッダ

Sub Account APIで共通して使用されるヘッダの詳細は、Sub Accountのリクエストヘッダをご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
trustAnchorId String Required Trust Anchor ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
name String Optional Trust Anchor名
  • ハングル、英字の大文字・小文字、日本語、記号。 「_ -」を使用して3~30文字
  • 先頭文字はハングル、英字の大文字・小文字、日本語
description String Optional Trust Anchorの説明(Bytes)
  • 0~300
source Object Optional CA情報
source.sourceType String Required CAタイプ
  • NCP_PCA | CERTIFICATE_BUNDLE
    • NCP_PCA: NAVERクラウドプラットフォームの Private CAを使用する場合
    • CERTIFICATE_BUNDLE: ユーザーが外部で作成した CAを使用する場合
source.sourceData Object Optional CA対象情報
source.sourceData.caId Integer Optional NAVERクラウドプラットフォームの Private CA ID
  • sourceType: NCP_PCAの場合
source.sourceData.x509CertificateData String Optional ユーザーが外部で作成した CA証明書データ
  • PEM形式
  • sourceType: CERTIFICATE_BUNDLEの場合

リクエスト例

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

  • source.sourceTypeが NCP_PCAの場合
    curl --location --request PATCH 'https://externalaccess.apigw.ntruss.com/api/v1/trust-anchors/a271f5b5-****-****-****-bda95123e58e' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ta000",
    "description": "Trust Anchor",
    "source": {
        "sourceType": "NCP_PCA",
        "sourceData": {
            "caId": ****
        }
    }
}'
  • source.sourceTypeが CERTIFICATE_BUNDLEの場合
    curl --location --request PATCH 'https://externalaccess.apigw.ntruss.com/api/v1/trust-anchors/a271f5b5-****-****-****-bda95123e58e' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ta000",
    "description": "Trust Anchor",
    "source": {
        "sourceType": "CERTIFICATE_BUNDLE",
        "sourceData": {
            "x509CertificateData": "-----BEGIN CERTIFICATE-----\n{CA}\n-----END CERTIFICATE-----"
        }
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
trustAnchorId String - Trust Anchor ID
trustAnchorNrn String - Trust Anchorに対する NAVERクラウドプラットフォームリソースの識別値
name String - Trust Anchor名
description String - Trust Anchorの説明
enabled Boolean - 状態
  • true | false
    • true: 有効化
    • false: 無効化
createTime String - 作成日時
  • ISO 8601形式
updateTime String - 最終更新日時
  • ISO 8601形式
source Object - CA情報
source.sourceType String - CAタイプ
  • NCP_PCA | CERTIFICATE_BUNDLE
    • NCP_PCA: NAVERクラウドプラットフォームの Private CAを使用する場合
    • CERTIFICATE_BUNDLE: ユーザーが外部で作成した CAを使用する場合
source.sourceData Object - CA対象情報
source.sourceData.caId Integer - NAVERクラウドプラットフォーム Private CAの ID
  • sourceType: NCP_PCAの場合
source.sourceData.x509CertificateData String - ユーザーが外部で作成した CA証明書データ
  • PEM形式
  • sourceType: CERTIFICATE_BUNDLEの場合

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

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

レスポンス例

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

  • source.sourceTypeが NCP_PCAの場合

    {
    "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
    "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
    "name": "ta000",
    "description": "test",
    "enabled": false,
    "createTime": "2024-12-13T13:16:50.330726376+09:00",
    "updateTime": "2024-12-13T13:16:50.330726376+09:00",
    "source": {
        "sourceType": "NCP_PCA",
        "sourceData": {
            "caId": *****
        }
    }
}

  • source.sourceTypeが CERTIFICATE_BUNDLEの場合

    {
    "trustAnchorId": "a271f5b5-****-****-****-bda95123e58e",
    "trustAnchorNrn": "nrn:PUB:ExternalAccess::*******:TrustAnchor/a271f5b5-****-****-****-bda95123e58e",
    "name": "ta000",
    "description": "test",
    "enabled": false,
    "createTime": "2024-12-13T13:16:50.330726376+09:00",
    "updateTime": "2024-12-13T13:16:50.330726376+09:00",
    "source": {
        "sourceType": "CERTIFICATE_BUNDLE",
        "sourceData": {
            "x509CertificateData": "-----BEGIN CERTIFICATE-----\n{CA}\n-----END CERTIFICATE-----"
        }
    }
}