Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Vault secrets
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオのエクスポート
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオの作成
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. Vault secrets

ApidogのVault Secret利用

TIP
Vault SecretsはApidog Enterpriseプランで利用可能。
Apidogを使用する際、HashiCorp Vault、Azure Key Vault、AWS Secrets Managerなどの外部Vaultからシークレットを取得し、リクエスト送信時にグローバル変数のように使用できる。
管理者はチームやプロジェクトの外部Vaultとの連携を設定でき、その後ユーザーはOAuth2.0でログインするか、自身のアクセストークンを入力するだけで外部Vaultからシークレットを取得できる。
取得したシークレットはローカルクライアントで暗号化して保存され、プライバシーが保護され、他者と共有されることはない。

Vaultプロバイダーの設定#

チームリソースページで、チーム用に複数のVaultプロバイダーを設定できる。各プロバイダーは要件に基づいて異なるプロジェクトに割り当てることができる。
SCR-20241212-qpuy.png
プロジェクト内で、そのプロジェクト専用のVaultプロバイダーをカスタマイズするか、チームレベルで設定されたプロバイダーを使用するかを選択できる。
SCR-20241213-pnah.png
詳細はこちら:
HashiCorp Vault
Azure Key Vault
AWS Secrets Manager

シークレットのリンクと取得#

プロジェクトの右上にある環境メニューの横のボタンをクリックし、Vault Secretsを選択する。
value入力ボックスで、外部Vaultに保存されているシークレットのメタデータ(エンジン、パス、キーなど)を設定する。必要なメタデータはVaultプロバイダーによって異なる。
SCR-20241213-pnfw.png
Fetch Secretsをクリックしてシークレットを取得すると、ローカルクライアントで安全に暗号化して保存される。
SCR-20241213-pnhv.png

シークレットの使用#

シークレットは変数がサポートされているあらゆるコンテキストで使用でき、{{vault:key}}という構文に従う。
SCR-20241213-pnnc.png
スクリプト内では、await pm.vault.get("key")を使用してシークレットの値を取得できる。console.logで値を出力する場合、値はマスクされる。
SCR-20241213-pojf.png
シークレットの値は決してチームメンバーと共有されない。ただし、再設定の手間を省くため、変数名とメタデータは共有される。チームメンバーは適切な認証を使用してシークレットを取得でき、コラボレーションとプライバシーのバランスが保たれる。

企業がVaultを使用するメリット#

シークレットの安全な保存:VaultはAPIキー、パスワード、証明書、トークンなどの機密情報を安全に保存する方法を提供し、不正アクセスから保護する。
アクセス制御:Vaultは厳格なアクセス制御ポリシーを定義でき、特定のシークレットへのアクセスを許可されたユーザーやサービスのみに制限できる。
暗号化:Vaultは保存時と転送時の両方でデータを保護する組み込みの暗号化を提供し、セキュリティの層を追加する。
監査とモニタリング:Vaultは誰がどのシークレットにいつアクセスしたかを追跡する監査とモニタリング機能を提供する。これはコンプライアンスと不正アクセスの試みの検出に役立つ。
他のサービスとの統合:Vaultは他のクラウドサービス(Apidogを含む)やDevOpsツールとシームレスに統合するように設計されており、様々な環境でシークレットを簡単に管理できる。
一元管理:Vaultは異なるアプリケーション、サービス、環境全体でシークレットを一元的に管理する方法を提供し、シークレット管理に関連するオーバーヘッドを簡素化する。
リスク軽減:認証情報がアプリケーションにハードコードされたり、ソースコードに漏洩したりする可能性を減らすことで、認証情報の露出リスクを軽減する。

ApidogでVault Secretsを使用するための前提条件#

シークレットがHashiCorp Vault、Azure Key Vault、またはAWS Secrets Managerに既に保存されていること。
組織またはチームがApidog Enterpriseプランに加入していること。
Modified at 2025-02-25 09:12:54
Previous
変数の使い方
Next
AWS Secrets Manager
Built with