Update Protection Key

Prev Next

VPC環境で利用できます。

Secret保護キーを変更します。REVOKE(削除リクエスト)状態のシークレット保護キーは変更できません。

リクエスト

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

メソッド URI
PUT /api/v1/secrets/{secretId}/protection-key

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
secretId String Required シークレット ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
protectionKeyType String Required 保護キータイプ
  • DEFAULT (デフォルト) | USER_MANAGED_KEY
    • DEFAULT: デフォルトのキー
    • USER_MANAGED_KEY: ユーザー管理キー
kmsKeyTag String Conditional KMSキータグ

リクエスト例

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

curl --location --request PUT 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/protection-key' \
--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 '{
    "protectionKeyType": "USER_MANAGED_KEY",
    "kmsKeyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
data Object - レスポンス結果
data.secretId String - シークレット ID
data.protectionKey Object - 保護キー情報
data.protectionKey.type String - 保護キータイプ
  • DEFAULT (デフォルト) | USER_MANAGED_KEY
    • DEFAULT: デフォルトのキー
    • USER_MANAGED_KEY: ユーザー管理キー
data.protectionKey.kmsKeyTag String - KMSキータグ
data.protectionKey.kmsKeyName String - KMSキー名

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
        "protectionKey": {
            "type": "USER_MANAGED_KEY",
            "kmsKeyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****",
            "kmsKeyName": "test-***"
        }
    }
}