API トークンの使用について
最終更新日 2021-03-10
API トークンは、個々のユーザーに割り当てられる固有の認証情報です。Fastly API を使用するには、API トークンを作成する必要があります。API トークンを使用して、アプリケーションに Fastly アカウントとサービスへの制限付きアクセスを許可することができます。例えば、エンジニアのユーザーは、トークンを単一のサービスにしかアクセスできないように制限し、URL によるパージだけにそのトークンのスコープを制限することができます。すべての Fastly ユーザーは、最大100個の API トークンを作成することができます。
ユーザーのロールに応じて、コントロールパネル内の2か所でトークンを管理できます。個人用 API トークンのページでは、個人のプロフィールに関連する API トークンの作成、表示、削除ができます。アカウント API トークンページでは、スーパーユーザーが組織の Fastly アカウントに関連付けられている API トークンを表示および削除できます。
ベストプラクティス
API トークンのサービスアクセスを制限し、有効期限を設定することで、クレデンシャルのアクセスを制限し、クレデンシャルが漏洩した場合の被害リスクを最小限に抑えることができます。詳細については、最小特権の原則をご覧ください。
API トークンの作成
API トークンの作成は、以下の手順で行います。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account をクリックします。アカウント情報が表示されます。
- Personal API トークンをクリックします。Personal API Tokens ページが表示されます。
-
Create token ボタンをクリックします。Create a Token ページが表示されます。
注意プロンプトが表示された場合は、必ずログインを再認証してください。
- 以下の要領で Create a Token ページの各フィールドに入力します。
- Name フィールドに、トークンの用途や使用場所を示す API トークンの分かりやすい名前を入力します。
- Apply to セクションでは、トークンのサービスレベルのアクセスを1つのサービスに限定する場合はそのサービスを選択し、すべてのサービスへのアクセスを API トークンに許可する場合は All Services に切り替えます。
- Set a scope セクションでは、1つまたは複数のチェックボックスを選択して、トークンのスコープを設定します。
- Global API access (global): パージを含むすべてのエンドポイントへのアクセスを許可します。
- Purge select content (
purge_select
): サロゲートキーや URL を使ったパージを許可します。すべてのキャッシュをパージする機能は含まれていません。 - Purge full cache (
purge_all
):purge_all
の API リクエストによってサービス全体をパージできます。 - Read-only access (global:read): アカウント情報、設定、統計情報への読み取り専用のアクセスを許可します。
- Set a token expiration セクションでは、API トークンの期限をなくすことも可能です。API トークンは、デフォルトでは90日後に失効するように設定されています。トークンの有効期限が切れた後にそのトークンを何らかのリクエストに使用すると、HTTP 401 レスポンスが返されます。
- Create ボタンをクリックすると、新しい API トークンが作成されます。トークンを構成する文字列が表示されます。
これは、Fastly API を通じて認証を行う際に使用するクレデンシャルです。この文字列は二度と表示されないので安全な場所に保存してください。同一のトークンを複数のアプリケーションで使用することは可能です。
API トークンの表示
アカウントの API トークンは、割り当てられたロールに応じて2種類表示できます。
個人用 API トークンの表示
個人用 API トークンを表示するには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account をクリックします。アカウント情報が表示されます。
-
Personal API トークンをクリックします。Personal API tokens ページにお客様の個人用トークンのリストが表示されます
アカウント API トークンの表示
アカウントの API トークンをスーパーユーザーとして表示するには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account をクリックします。アカウント情報が表示されます。
-
Account API tokens をクリックします。 Account API Tokens ページに、組織の Fastly アカウントに関連付けられたトークンのリストが表示されます。
API トークンの削除
API トークンを削除すると、そのクレデンシャルを使用しているすべての統合が解除されます。削除を実行する前に、統合のための API トークンが変更されていることを確認してください。
個人用 API トークンの削除
個人用 API トークンを削除するには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account をクリックします。アカウント情報が表示されます。
- Personal API tokens をクリックします。Personal API Tokens ページにお客様の個人用トークンのリストが表示されます。
- 削除したい API トークンを見つけて、ゴミ箱のアイコンをクリックします。警告メッセージが表示されます。
- Delete ボタンをクリックすると、API トークンが永久に削除されます。
アカウント API トークンの削除
アカウント API トークンを削除したり、スーパーユーザーとして他のユーザーの API トークンを無効にするには、以下の手順に従ってください。
- Fastly コントロールパネルにログインし、ユーザーメニューから Account をクリックします。アカウント情報が表示されます。
- Account API tokens をクリックします。 Account API Tokens ページに、組織の Fastly アカウントに関連付けられたトークンのリストが表示されます。
- 削除したい API トークンを見つけて、ゴミ箱のアイコンをクリックします。警告メッセージが表示されます。
- Delete ボタンをクリックすると、API トークンが永久に削除されます。
レガシー API キー
お客様の Fastly のアカウントが2017年5月15日以前に作成された場合、API リクエストの認証に API キー (1つまたは複数の API キー) が使用された可能性があります。このアカウントレベルのクレデンシャルは、スコープが global
に設定され、すべてのサービスにアクセスできる個人用 API トークンに移行しました。すべてのトークンはユーザーによって所有される必要があるため、このクレデンシャルは Global API Token
という名前で、新たに作成された人工的なユーザーに割り当てられています。