Skip to main content

CaseBender エンドポイント

OpenAPI 仕様ファイルを表示

認証

すべての API エンドポイントは API キーによる認証が必要です。以下のいずれかの方法で、すべてのリクエストに API キーを含めてください。

推奨: Bearer トークン

Authorization ヘッダーに Bearer トークンとして API キーを含めます。

代替: X-Api-Key ヘッダー

X-Api-Key ヘッダーを使用することもできます。
重要: API キーは CaseBender インスタンスへのアクセスを許可します。安全に保管し、決して公開しないでください。

API キーの作成

API キーを作成するには:
  1. CaseBender インスタンスにログインします
  2. アカウントAPI キー に移動します
  3. API キーを作成 をクリックします
  4. キーの名前、説明、ティア(tier)、スコープ(scope)を設定します
  5. キーをすぐに保存してください — キーは一度だけ表示され、後から取得することはできません
API キーを作成すると、次のような単一のキーが発行されます。

API キーの使用

すべての API リクエストに API キーを含めます。

cURL の場合

Python の場合(requests ライブラリ)

JavaScript/Node.js の場合(fetch)

API キーのティア

API キーには、レート制限を決定するティアが割り当てられます。

API キーのスコープ

API キーを作成する際に、アクセスを特定の操作に制限できます。
  • alerts:read - アラートの読み取り
  • alerts:write - アラートの作成と更新
  • cases:read - ケースの読み取り
  • cases:write - ケースの作成と更新
  • observables:read - オブザーバブルの読み取り
  • observables:write - オブザーバブルの作成と更新
  • users:read - ユーザー情報の読み取り
  • admin:* - 管理操作

よくある認証エラー

  • 401 Unauthorized:
    • Authorization ヘッダーがない
    • API キーが無効または期限切れ
    • API キーが取り消しまたは停止されている
  • 403 Forbidden:
    • API キーに操作に必要なスコープがない
    • TLP/PAP アクセス制限
  • 429 Too Many Requests:
    • ティアのレート制限を超過

セキュリティのベストプラクティス

  • API キーを共有しない — パスワードと同様に扱ってください
  • API キーを定期的にローテーションする — 古いキーを取り消し、定期的に新しいキーを作成します
  • アプリケーションごとに異なるキーを使用する — アプリケーション単位でアクセスを取り消せます
  • 有効期限を設定する — 可能な場合は API キーが自動的に期限切れになるように設定します
  • 必要最小限のスコープを使用する — アプリケーションに必要な権限のみを付与します

レガシー認証(非推奨)

レガシーの x-api-key および x-api-secret ヘッダーは後方互換性のために引き続きサポートされていますが、非推奨です。Bearer トークン認証に移行してください。