Secret Managerの概要

Prev Next

VPC環境で利用できます。

Secret Managerは、セキュリティパスワードを安全に保存、変更、管理する NAVERクラウドプラットフォームのサービスです。Secret Managerサービスは、セキュリティパスワードの作成、照会、ローテーション、削除管理関連の APIを RESTfulの形式で提供します。

Secret Managerの共通設定

Secret Manager APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

韓国(KR)リージョンは、Secretが暗号化された Key Management Service(以下 KMS)キーの隔離タイプによって API URLが異なります。

リージョン KMS全域キー暗号化連携 Secret KMS隔離キー暗号化連携 Secret
韓国(KR) https://secretmanager.apigw.ntruss.com https://ocapi-kr.ncloud.com/secretmanager

日本リージョンは KMSのリージョン隔離キーのみ利用して暗号化することができます。API URLは以下の通りです。

リージョン Secret Manager API
日本(JPN) https://ocapi-jp.ncloud.com/secretmanager
注意

Key Management Service(KMS)のリージョン隔離キー機能がアップデートされ、Secret Managerでもリージョン隔離キーを連携できます。アップデート前に全域キーで連携されたシークレットはそのまま使用できますが、新規シークレット連携時に全域キーは選択できなくなりました。詳細は、Key Management Serviceの概要をご参照ください。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
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 Optional リクエストデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

responseError
responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
error Object - エラー情報
error.errorCode String - エラーコード
error.message String - エラーメッセージ
error.details String - エラーの詳細情報

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

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
403 FORBIDDEN Forbidden 認証完了または権限なしでリクエストを拒否
500 INTERNAL_SERVER_ERROR Server internal error サーバ内部エラー
422 UNPROCESSABLE_ENTITY Invalid status リクエストは有効だが、ルール違反
400 INVALID_REQUEST Invalid request 無効なリクエスト
401 UNAUTHORIZED Unauthorized 認証情報なし
404 NOT_FOUND Not found リクエストリソースなし
409 INVALID_STATUS Invalid status 無効な状態値
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
  "error": {
    "errorCode": "string",
    "message": "string",
    "details": "string"
  }
}

Secret Manager API

Secret Managerサービスが提供する APIの説明は次の通りです。

API 説明
Create Secret シークレットを作成
Get Protection Key List 保護キーリストを照会
Get Secret Detail シークレットの詳細情報を照会
Get Secret List シークレットリストを照会
Get Secret Logs シークレット利用ログを照会
Get Secret Stage Value 特定のシークレットステージのシークレット値を照会
Get Secret Value シークレット値を照会
Get Trigger List トリガーリストを照会
Cancel Rotation Job 実行中のシークレットローテーションジョブをキャンセル
Cancel Secret Deletion シークレットの削除リクエストをキャンセル
Disable Auto Rotation シークレット自動ローテーションを無効化
Disable Secret シークレットを無効化
Enable Auto Rotation シークレット自動ローテーションを有効化
Enable Secret シークレットを有効化
Execute Rotation Job シークレットローテーションジョブを実行
Request Secret Deletion シークレット削除リクエストを作成
Retry Rotation Job シークレットローテーションジョブを再試行
Rollback Rotation Job シークレットローテーションジョブをロールバック
Update Protection Key 保護キーを変更
Update Rotation Period シークレットローテーション周期を変更
Update Rotation Trigger シークレットローテーショントリガーを変更
Update Secret Memo シークレットの説明を更新
Update Secret Stage Value 特定のシークレットステージのシークレット値を更新
Update Secret Value シークレットステージ全体のシークレット値を変更
Delete Rotation Trigger シークレットローテーショントリガーを削除
Delete Secret シークレットを削除

Secret Rotate Process Control

Secret Rotate Process Control関連の APIの説明は次の通りです。

API 説明
Add Pending Stage Pendingステージを作成
Generate Random Secret 任意のシークレット文字列を作成
Complete Rotation Job シークレットローテーションジョブ完了を通知
Fail Rotation Job シークレットローテーションジョブ失敗を通知
Start Rotation Job シークレットローテーションジョブを開始
Update Pending Stage Pendingステージのシークレット値を更新

Secret Manager関連リソース

Secret Manager APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。