APIキーの管理
API Keys ページでは、アプリケーションが FourA API を呼び出すために使用するキーを作成、表示、管理できます。
キーの表示
このページには、アクセス権を持つすべてのキーが表示されます。これには、個人用キーおよび所属する組織が所有するすべてのキーが含まれます。アクセス権はメンバーシップによって付与されるため、一般メンバーにも組織のキーが表示されます。
| 列 | 表示内容 |
|---|---|
| Name | 表示名、および設定されている場合は説明 |
| Owner | Personal、または組織名 |
| Key Prefix | キーの先頭文字とそれに続くマスク (pk_live_a1b2••••••••)、Reveal ボタン、またはレガシーキーのロックアイコン |
| Status | Active または Inactive |
| Created | キーが作成された日時 |
| Last Used | キーが最後にリクエストを実行した日時 |
名前や説明で検索し、Active または Inactive でフィルタリングし、Name、Owner、Status、Created、または Last Used で並べ替えることができます。並べ替えの順序は、降順、昇順、オフの順で切り替わります。
Owner フィルター
1 つ以上の組織に所属している場合、検索ボックスの横に Owner ドロップダウンが表示されます。選択肢は Everything、Personal、または各組織のエントリです。これにより、指定した所有者のキーのみにリストが絞り込まれます。また、Overview、Metrics、Activity、Proxy にある同じコントロールもこの選択に連動するため、これら 5 つのページで表示対象のトラフィックの所有者が常に一致します。
キーの作成
リストの上にある Create Key(最初のキーを作成する前の空のページでは Create API key)をクリックし、以下を入力します。
| フィールド | 必須 | 説明 |
|---|---|---|
| Name | はい | 「production-scraper」や「staging-test」などのわかりやすいラベル |
| Description | いいえ | このキーの用途に関するメモ |
| Owner | 組織に所属している場合は必須 | Personal、または所属する任意の組織。組織に 1 つ以上所属している場合にのみ選択項目が表示されます。 |
組織のメンバーであれば、ロールに関係なく、その組織が所有するキーを作成できます。これがこの設定の目的です。組織キーの使用量は組織の所有者に請求されるため、開発者が会社の代わりに個人キーで誤って課金される心配がありません。
完全なキーは、作成直後にコピー可能なダイアログで一度だけ表示されます。後から Reveal を使用して再表示することも可能です。キーにはプレフィックス pk_live_ が使用され、pk_live_a1b2c3d4e5f6... のような形式になります。キーが作成されると確認メールが送信されます。
プランによって保持できるアクティブなキーの数が決まります。これには、個人用キーと所有する組織のキーが含まれます。組織向けに作成されたキーは、その組織の所有者のプランにカウントされます。上限に達すると、プランの上限数を示すメッセージとともにキーの作成が拒否されるため、使用しなくなったキーを無効化または削除するか、プランをアップグレードしてください。
キーの再表示
マスクされたプレフィックスの横にある目のアイコンをクリックすると、完全なシークレットを再度確認できます。ダッシュボードで確認を求められた後、プレーンテキストのキー、コピーボタン、短いカウントダウンが表示されたダイアログが開きます。カウントダウンが終了すると、ダイアログによりページからシークレットが消去されます。
有効な認証情報が開示されるため、すべての再表示操作は監査ログに記録されます。
キーが共有されているユーザーは誰でもそのキーを表示できます。具体的には、個人の所有者、またはそのキーを所有する組織のメンバー全員です。
レガシーキー
表示機能が導入される前に作成されたキーには、目アイコンの代わりに鍵アイコンが表示され、内容を表示することはできません。ハッシュのみが保存されていたため、元のシークレットは復元不可能です。レガシーキーを移行するには、アクションメニューを開いてRegenerateを選択します。新しいシークレットは、それ以降いつでも表示可能になります。
各ロールで実行可能な操作
個人キーでは、すべての操作を実行できます。組織キーでは、以下の3つの権限レベルが適用されます。
| 操作 | Member | Admin | Owner |
|---|---|---|---|
| キーの使用と表示 | 可 | 可 | 可 |
| 名前の変更、説明の編集 | 可 | 可 | 可 |
| 有効化または無効化 | 不可 | 可 | 可 |
| シークレットの再生成 | 不可 | 可 | 可 |
| 削除 | 不可 | 可 | 可 |
| 組織外への移動 | 不可 | 不可 | 可 |
無効化と編集のボタンは行に残りますが、グレーアウトされ、理由を説明するメモが表示されます。再生成、移行、削除は、使用する権限がロールにない場合、メニューに表示されません。APIも同一の操作を拒否するため、インテグレーションがUIの制限を回避することはできません。
この権限の区分は、キーを共有する関係者への各操作の影響度に基づいています。名前の変更による影響はありません。再生成や無効化は、実行した瞬間に同僚のすべてのインテグレーションを停止させます。キーを組織外へ移動すると、会社からキーが削除され、その使用量が移行先のプランに請求されるため、この操作はOwnerのみに制限されています。
キーの編集
名前と説明を更新するには、Editをクリックします。このダイアログでは所有権を変更できません。変更にはTransferを使用してください。
アクションメニューのView Metricsをクリックすると、そのキーでフィルタリングされたOverviewが開きます。
有効化と無効化
該当する行のDisableまたはEnableを使用します。キーを無効化すると、そのキーを使用するすべてのAPIリクエストがブロックされます。キーはいつでも再有効化できます。変更は1分以内に反映されます。
キーの再生成
キーが漏洩した疑いがある場合は、アクションメニューを開いてRegenerateを選択します。これにより、同じキーIDに対して新しいシークレットが生成されます。古いシークレットは1分以内に機能しなくなります。名前、所有者、その他の設定はすべて維持されます。
新しいシークレットはダイアログを閉じた後も表示可能な状態が保たれるため、最初の画面で慌ててコピーする必要はありません。
キーの移行
アクションメニューのTransferを使用すると、シークレットを再生成することなく、個人と組織の間でキーの所有権を移動できます。キーID、メトリクス、アクティビティ履歴は保持されます。所有者のみが変更され、それに伴い使用量の請求先が変わります。
| 移動 | 実行可能なユーザー |
|---|---|
| 個人キーを組織へ移動 | その組織に所属する全員 |
| 組織のキーを自身のアカウントへ移動 | その組織のOwner |
| 2つの組織間での移動 | キーの移動元組織のOwner |
組織へ移動したキーは、デフォルトの「Everyone」チームに追加され、メンバー全員から閲覧可能になります。組織外へ移動したキーは、所属していたすべてのチームから除外されます。
キーの削除
アクションメニューを開き、Delete を選択します。使用実績のあるキーを削除すると無効化されます。キーによる認証は停止し、リスト上には Inactive として保持されるため、Activity や Metrics の履歴でキー名が維持されます。一度も使用されていないキーは完全に削除されます。
キーが削除されるとメールが届きます。
組織キーと請求
組織が所有するキーの使用量は、リクエストの実行者に関わらず、組織オーナーのプランに対してカウントされます。オーナーの Usage & Limits ページでは、これらのキーが個人のキーと並んでカウントされ、両者が分けて表示されます。
関連情報
- Authentication: API における API キーの仕組み
- Organizations: ロール、メンバー、共有アクセス
- Usage & Limits: プランに対してカウントされるキー
- Dashboard Overview: すべてのダッシュボードセクション