API トークンの利用
最終更新日 2022-12-08
API トークンは、人間のユーザーと自動化システムが Fastly に身元を証明して信用できることを示す一意のセキュリティ認証情報で、Fastly API の使用による制限されたリソースへのアクセスや、特定の制限された操作の実行を許可するのに使用されます。
API トークンについて
ユーザートークンと自動化トークンの2種類の API トークンがあります。それぞれの種類のトークンについて、特定のアクティビティのスコープを指定することで、機能を任意で制限できます。
トークンの種類
2種類の API トークンがあります。割り当てられているロールと権限に基づいて、トークンを管理できるかどうかが決まります。
- ユーザートークン。ユーザートークンは、人間のユーザーが開始した API アクティビティの許可を得るのに必要なセキュリティ認証情報を提供します。特定の人間に関連付けられており、そのユーザーのアカウントの有効期間のみ有効です。ユーザートークンは、「個人用トークン」または「個人用 API トークン」と呼ばれる場合があります。
誰でも自分のユーザートークンを作成および確認することができます。これらのトークンは、API 経由でアカウントベースのアクションを実行するユーザーと同じ権限を持ちます。例えば、請求担当者のユーザートークンでは請求担当のロールに割り当てられている機能の実行のみが許可されます。ユーザーのアカウントが削除された場合、有効な API トークンを無効化する必要があります。
自動化トークン。自動化トークンは、人間以外のクライアント (継続的インテグレーション用およびビルド用のシステムなど) にセキュリティ認証情報を提供します。このようなクライアントは、継続的インテグレーションやデプロイのパイプライン、日常的なスクリプト化されたタスクなど、自動化された API アクティビティの実行に使用されます。自動化トークンは、「アカウントトークン」または「サービスアカウントトークン」と呼ばれる場合があります。
自動化トークンを作成できるのはスーパーユーザーのみです。これらのトークンは特定の人間のユーザーに関連付けられることがないため、無期限に有効にすることが可能です。企業のプロファイル設定の一部としてのみ表示され、スーパーユーザーのロールが割り当てられた人間のユーザーのみが管理することができます。
トークンのスコープ
サービスに関連したアクティビティのスコープを指定することで、API トークンの機能を制限することができます。具体的には、以下のように API トークンを許可または制限することができます。
- Global API access (
global) が選択されているトークンの場合、パージを含むすべての API エンドポイントへのアクセスが許可され、サービスを完全にコントロールできます。 - Purge full cache (
purge_all) が選択されているトークンの場合、purge_allの API リクエストによってサービス全体をパージできます。 - Purge select content (
purge_select) が選択されているトークンの場合、サロゲートキーや URL を使用してパージできますが、すべてのキャッシュをパージすることはできません。 - Read-only access (
global:read) が選択されているトークンの場合、アカウント情報や設定、統計情報への読み取り専用アクセスが可能です。
制限とベストプラクティス
API トークンの管理および使用時には、以下の制限に留意してください。
- API トークンは作成、表示、削除のみ可能です。編集や更新はできません。
- 各ユーザーにつき、有効な API トークンは100個に制限されています。削除済みおよび期限切れのトークンは、制限にカウントされません。
API トークンを作成する際、以下のベストプラクティスに留意してください。
トークンを機密情報として扱います。トークンを安全に保管します。新しいトークンを生成する際は、パスワードマネージャーなど保護された場所に保存し、機密性と安全性を確保する必要があります。セキュリティ上の理由により、トークンをコピーできるのは作成時に一度だけです。あとでトークンの文字列を取得することはできません。
最小限の特権を付与することを検討してください。トークンのサービスへのアクセスの制限、スコープの指定、有効期限の設定により、その認証情報で可能なアクセスを制限し、セキュリティ認証情報が何らかの形で侵害された場合のリスクを最小限に抑えることができます。詳細については、最小特権の原則をご覧ください。
API トークンの作成
API トークンの作成は、以下の手順で行います。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account リンクをクリックします。アカウント情報が表示されます。
API tokens のリンクをクリックします。API Tokens ページが表示されます。
Create Token ボタンをクリックします。
プロンプトが表示されたら、パスワードを入力して権限を再認証します。Create a Token ページが表示されます。
以下の要領で Create a Token ページの各フィールドに入力します。
- Name フィールドに、そのトークンが使用される方法と場所を示す、分かりやすい名前を入力します。
- Type オプションで、作成する API トークンの種類を任意で選択します (
User tokenまたはAutomation token)。自動化トークンを作成できるのは、スーパーユーザーのみです。Automation tokenを選択すると、そのトークンのユーザーロールを指定するセクションが表示されます。 - Role オプションで、API トークンに適切なアクセス権限を割り当てるユーザーロールを選択します。使用可能なオプションは、
Engineer、UserおよびBillingです。 詳細は、ユーザーロールと権限の設定に関するガイドをご覧ください。 - 必要に応じて、TLS management を選択して、トークンに TLS 証明書とドメインを含むすべてのサービスで TLS 設定を変更する権限を付与します。
- Scope オプションで、1つ以上のチェックボックスを選択し、トークンのアクセスを 特定のスコープ に制限します。選択した役割に適用されるスコープオプションのみが選択可能になります。詳細は、ユーザーロールと権限の設定に関するガイドをご覧ください。
- Access オプションで、すべてのサービスを選択するか、または Search or select service メニューで特定のサービスまたはサービスのグループを選択し、トークンのアクセスをそれらのサービスに制限します。
- Expiration オプションで、トークンの有効期限の範囲を設定します。デフォルトでコントロールパネルによって、トークンが作成された日から90日間に有効期限が設定されますが、トークンの有効期限を無期限に設定することも、期限切れになる特定の日付を選択することも可能です。
ヒント
トークンの有効期限が切れた後にそのトークンを何らかのリクエストに使用すると、HTTP 401 のレスポンスが返されます。
Create Token ボタンをクリックすると、新しい API トークンが作成されます。新しいトークンとその作成通知が表示されます。これは、Fastly API を通じて認証を行う際に使用するクレデンシャルです。同一のトークンを複数のアプリケーションで使用することは可能です。
クリップボードのアイコンをクリックして API トークン文字列をコピーし、機密性が高い安全な場所に保存してください。
警告
API トークン文字列が表示されるのは、この時だけです。すぐにコピーして安全な場所に保存してください。二度と表示されることはありません。
OK をクリックします。
API トークンの表示
API トークンを表示するには、以下の手順に従ってください。
ユーザートークンの表示
個人用ユーザートークンを表示するには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account リンクをクリックします。アカウント情報が表示されます。
API tokens のリンクをクリックします。API Tokens ページにお客様の個人用トークンのリストが表示されます。
アカウントトークンの表示
スーパーユーザーのロールが割り当てられている場合、以下の手順でアカウントトークンを表示できます。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account リンクをクリックします。アカウント情報が表示されます。
- Account tokens リンクをクリックします。 Account Tokens ページに、組織の Fastly アカウントに関連付けられたトークンのリストが表示されます。
API トークンの削除
警告
API トークンを削除すると、その認証情報を使用しているすべての統合が解除されます。
ユーザートークンまたは自動化トークンを削除するには、以下の手順に従ってください。
ユーザートークンの削除
ユーザートークンを削除するには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account リンクをクリックします。アカウント情報が表示されます。
- API tokens のリンクをクリックします。API Tokens ページにお客様の個人用ユーザートークンのリストが表示されます。
- 削除したいトークンを見つけて、ゴミ箱のアイコンをクリックします。警告メッセージが表示されます。
- Delete ボタンをクリックすると、ユーザートークンが永久に削除されます。
アカウントトークンの削除
アカウントトークンを削除する、またはスーパーユーザーとして別のユーザーのトークンを無効にするには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account リンクをクリックします。アカウント情報が表示されます。
- Account tokens リンクをクリックします。Account Tokens ページに、お客様の組織の Fastly アカウントに関連付けられたトークンのリストが表示されます。
- 削除したいトークンを見つけて、ゴミ箱のアイコンをクリックします。警告メッセージが表示されます。
- Delete ボタンをクリックすると、トークンが永久に削除されます。
レガシー API 認証情報
お客様の Fastly のアカウントが2017年5月15日以前に作成された場合、API リクエストの認証に API キー (1つまたは複数の API キー) が使用された可能性があります。このアカウントレベルの認証情報は、スコープが global に設定され、すべてのサービスにアクセスできる API トークンに移行しました。Global API Token という名前で新たに作成されたシンセティックユーザーに割り当てられています。
