API トークンテンプレート URL

テンプレート URL を使うと、事前設定済みの権限で Cloudflare API トークンを生成できます。テンプレート URL があれば、ダッシュボードで権限を手作業で選ばなくても、トークンに必要な要件をユーザーと共有できます。

テンプレート URL はクエリパラメーターで、Cloudflare ダッシュボードの API トークン作成ページを事前入力します。ユーザーがテンプレート URL を開くと、ダッシュボードは指定した権限と設定を自動で構成します。

Cloudflare は ユーザートークン と アカウントトークン の両方でテンプレート URL をサポートします。これらのトークン種別の違いは、アカウント API トークン を参照してください。

ユーザートークンのテンプレート URL は、ユーザープロフィールレベル（/profile/api-tokens）のトークン作成フォームを開きます。この方法で作成したトークンは、そのユーザーが所有します。

基本的なテンプレート URL の構造は次のとおりです。

https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=[ENCODED_PERMISSIONS]&accountId=*&zoneId=all&name=[TOKEN_NAME]

アカウントトークンのテンプレート URL は、アカウントレベルのトークン作成フォームを開きます。この方法で作成したトークンはアカウントが所有し（サービスプリンシパルトークン）、特定のユーザーには結びつきません。アカウントトークンの作成には、Super Administrator または Administrator の権限が必要です。

基本的なテンプレート URL の構造は次のとおりです。

https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=[ENCODED_PERMISSIONS]&name=[TOKEN_NAME]

:account セグメントはプレースホルダーです。ユーザーが URL を開いたとき、複数のアカウントにアクセスできる場合は、ダッシュボードがアカウントの選択を求めます。

ユーザートークンとアカウントトークンのテンプレート URL は、同じ権限エンコードを使います。権限は次の構造の JSON 配列としてエンコードします。

[{ "key": "permission_name", "type": "read|edit|revoke|run|purge" }]

用途に必要な権限を洗い出します。権限リファレンス テーブルを参照してください。

権限を JSON 配列の形式にします。

[
	{ "key": "dns", "type": "edit" },
	{ "key": "analytics", "type": "read" }
]

URL エンコーダーで JSON 文字列を変換します。

%5B%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22analytics%22%2C%22type%22%3A%22read%22%7D%5D

ユーザートークン の場合は、すべての要素を最終的なテンプレート URL にまとめます。

https://dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=[ENCODED_JSON]&accountId=*&zoneId=all&name=Custom%20Token

アカウントトークン の場合は、アカウントレベルのパスを使います。

https://dash.cloudflare.com/?to=/:account/api-tokens&permissionGroupKeys=[ENCODED_JSON]&name=Custom%20Token

このテーブルで、カスタムテンプレート用の権限キーを探せます。

よくあるシナリオ向けの、すぐ使えるテンプレート URL です。各例にユーザートークン URL とアカウントトークン URL の両方があります。

DNS レコード管理用のトークンを作成します。

Workers、KV ストレージ、関連サービス向けのトークンを作成します。

分析とログにアクセスするためのトークンを作成します。

Cloudflare Zero Trust 管理用のトークンを作成します。

テンプレート URL を作成・共有するときは、次の指針に従ってください。

• 最小権限の原則: 用途に必要な最小限の権限だけを要求します。トークンが漏洩したときのセキュリティリスクを下げます。
• 分かりやすいトークン名を使う: テンプレート URL に明確で分かりやすい名前を含め、トークンの目的をユーザーが把握できるようにします。
• トークンの用途を文書化する: 各トークンの用途と、不要になったときの取り消し方法を明確に書いておきます。
• トークンを定期的にローテーションする: トークンを定期的にローテーションし、権限を見直すようユーザーに促します。
• 共有前にテストする: ユーザーに共有する前に、必ずステージング環境でテンプレート URL をテストします。

よくある問題と対処を確認します。

あわせて、テンプレート URL を共有する前に次を確認します。

• すべての権限キーが正しい
• JSON の構文が正しい
• URL エンコードが適切
• トークン名が分かりやすい
• 権限が最小権限の原則に従っている

• API トークンの権限
• API トークンを作成する
• アカウント API トークン
• API 認証