/
APIキーとAI接続のための15個のスコープ:各スコープで許可されること、ダッシュボードでの名前、どのAPIキーにもできないことを説明します。
スコープは、APIキーにできることを定めます。MCPで接続するAIアシスタントにも、同じ15個のスコープが適用されます。アプリケーションが本当に必要とするスコープだけを選んでください。
基本ルール
- 各エンドポイントには、ちょうど1つのスコープが必要です
- APIキーでは、write:Xにread:Xが自動的に含まれます。ダッシュボードには「write:X には read:X が自動的に含まれます」と記載されています
- スコープがない場合、APIは403 insufficient_scopeを返し、必要なスコープをdetails.required_scopeで示します
- そもそもAPIキーで使えないエンドポイントも、403 insufficient_scopeを返します
- メンバー、請求、ドメインの管理などのオーナーと管理者の機能には、どのスコープでもアクセスできません
すべてのスコープ
「新しいAPIキーを作成」ダイアログでは、分野ごとに「読み取り」または「書き込み」を選びます。キーの一覧には最初の列のスコープ名が表示されます。「読み取り · ページ」の形式は、AIアプリの同意ページと「連携済みアプリ」に表示されます。
| スコープ | AIアプリでの表示 | 許可されること |
|---|---|---|
| read:pages | 読み取り · ページ | ページの一覧表示と読み取り、下書きの読み取りと検証、ブロックの一覧表示、SEOの読み取り、バージョンの一覧表示、ブロックの種類の取得 |
| write:pages | 書き込み · ページ | ページの作成と編集(ハンドルを含む)、下書きの編集、ブロックの作成・編集・削除・並べ替え、SEOの編集、公開設定、公開、バージョンの復元、非公開ページの招待リンク |
| read:links | 読み取り · リンク | ページのリンクの一覧表示と読み取り |
| write:links | 書き込み · リンク | リンクの作成、編集、削除、並べ替え |
| read:assets | 読み取り · アセット | アセットの一覧表示 |
| write:assets | 書き込み · アセット | アセットのアップロードと削除、ページ用のアップロード |
| read:forms | 読み取り · フォーム | フォーム、概要の読み取り、送信内容の一覧表示とCSVエクスポート(エクスポートはCreator Pro以上) |
| write:forms | 書き込み · フォーム | フォームの作成、編集、削除 |
| read:stats | 読み取り · 統計 | ページとワークスペースの統計(概要、時系列、比較、リンク、ウィジェット、コンバージョン、上位のページ)、プッシュ履歴とプッシュの使用状況 |
| read:workspaces | 読み取り · ワークスペース | プランの機能、使用状況、メンバー一覧、ワークスペース設定の読み取り、ドメインの一覧表示、テンプレートの一覧表示と読み取り、コールバックシークレットの一覧表示と読み取り(平文のシークレットを除く) |
| write:workspaces | 書き込み · ワークスペース | 現在、read:workspaces以外のエンドポイントはありません |
| read:donations | 読み取り · 応援の支払い | ワークスペースの応援の支払い(「応援する」ブロック経由の支払い)の合計 |
| read:short_links | 読み取り · 短縮リンク | 短縮リンクの一覧表示と読み取り |
| write:short_links | 書き込み · 短縮リンク | 短縮リンクの作成、編集、削除 |
| write:templates | 書き込み · ワークスペーステンプレート | 独自のワークスペーステンプレートの作成、編集、削除(読み取りはread:workspaces)。独自テンプレートをご覧ください |
どのエンドポイントがどのスコープに属するかは、分野別のAPIエンドポイントに示しています。
どのAPIキーにもできないこと
- ページの削除
- 下書きのプレビューリンクの作成
- デバイス、国、リファラー、UTM別の統計の内訳
- プッシュ通知の送信とプッシュルールの管理
- 連携の接続と解除
- Webhookの管理
- ドメインの追加、検証、有効化、無効化、削除
- メンバー、招待、ロールの管理、オーナー権限の譲渡
- ワークスペース設定の変更、請求
- コールバックシークレットの作成、編集、ローテーション、削除
- 応援の支払いの一覧、データの開示請求、フォームの送信内容の匿名化
- プロフィール、フォロー中のページ、APIキー自体の管理
これらはダッシュボードで行います。
AIアシスタントのスコープ
MCP接続では、同意ページで同じスコープを選びます。違いが2つあります。1つ目に、そこでは書き込み権限に読み取り権限は含まれないので、両方を付与してください。2つ目に、ロールによって選択肢が制限されます。ビューアーには読み取り権限だけ(フォームと短縮リンクを除く)、エディターには「書き込み · ワークスペース」、短縮リンク、ワークスペーステンプレート以外のすべてが与えられます。詳しくはAIアシスタント:権限、セキュリティ、上限をご覧ください。
おすすめの組み合わせ
| 用途 | スコープ |
|---|---|
| レポートとダッシュボード | read:stats, read:pages |
| CMSやショップからリンクを同期 | write:links, read:pages |
| ページの自動管理と公開 | write:pages, write:links |
| CRMからのキャンペーンリンク | write:short_links |
| フォームのリードをCRMに渡す | read:forms |
| CIパイプラインからテンプレートを展開 | write:templates, read:workspaces |
こちらもおすすめ
答えが見つかりませんか?
お困りのことをお知らせください。サポートチームが個別にお手伝いします。