API キースコープ

概要

API キーにはスコープを設定でき、キーごとにアクセスできる操作を制限できます。スコープを設定しない場合（レガシーキー）は後方互換性のためフルアクセスが付与されます。

スコープの種類

以下の3種類のスコープが利用可能です。

• read — GET / HEAD リクエストのみ許可。データの読み取り専用アクセス。
• write — すべての HTTP メソッドを許可（read を含む）。データの作成・更新・削除が可能。
• full — すべての HTTP メソッドを許可。write と同等。

HTTP メソッドとスコープの対応

各 HTTP メソッドに必要なスコープは以下の通りです。

レガシーキー（スコープなし）

スコープが設定されていない API キーは、後方互換性のためすべての操作にアクセスできます。セキュリティ向上のため、新しいキーには必ずスコープを設定することを推奨します。

403 Forbidden レスポンス

スコープが不足している場合、API は 403 Forbidden を返します。

{
  "error": "Forbidden: API key missing required scope 'write'",
  "code": "FORBIDDEN"
}