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