APIキーの管理
API Keysページでは、アプリケーションがFourA APIを呼び出すために使用するキーの作成、表示、管理を行うことができます。
キーの表示
このページには、アクセス権限を持つすべてのキーが表示されます。
- 直接作成した個人キー。
- 組織のオーナーまたは管理者の場合は組織キー。
- チームメンバーシップを通じて共有されたチームキー。
表の各行には以下が表示されます。
| Column | What it shows |
|---|---|
| Name | 表示名と(オプションの)説明 |
| Key | マスクされたプレフィックス(例:pk_live_••••••••)と、その横にあるRevealボタン |
| Owner | 個人キーの場合はME、組織またはチーム共有キーの場合はTEAM |
| IP Allowlist | 設定されている場合は制限されたIP、制限がない場合は「All IPs」 |
| Expires | 設定されている場合は有効期限、設定されていない場合は「Never」 |
| Status | ActiveまたはInactive |
| Created | キーが作成された日時 |
| Last Used | キーが最後にリクエストを送信した日時 |
検索ボックスを使用して名前や説明でフィルタリングし、ステータスフィルターを使用してアクティブまたは非アクティブなキーのみを表示します。
キーの作成
Create Keyをクリックし、以下を入力します。
| Field | Required | Description |
|---|---|---|
| Name | Yes | 分かりやすいラベル(例:「production-scraper」や「staging-test」) |
| Description | No | このキーの用途に関するメモ |
組織に所属している場合は、個人アカウントではなく、その組織にキーを割り当てることもできます。
作成直後に、コピー可能なダイアログで完全なキーが一度だけ表示されます。また、キーがReveal機能のリリース後に作成されたものであれば、後からReveal(下記参照)を介して再度表示することもできます。
キーはpk_live_プレフィックスを使用し、pk_live_a1b2c3d4e5f6...のようになります。新しいキーが作成されると、確認のメールが届きます。
キーの再表示(Reveal)
キーのマスクされたプレフィックスの横にある目のアイコンをクリックすると、完全なシークレットを再度確認できます。ダッシュボードで確認を求められた後、プレーンテキストのキー、コピーボタン、15秒のカウントダウンが表示されたダイアログが開きます。カウントダウンの後、ダイアログはページからシークレットを消去します。
有効な認証情報が公開されるため、すべてのRevealは監査ログに記録されます。
レガシーキー
この機能がリリースされる前に作成されたキーには、目のアイコンの代わりに南京錠のアイコンが表示され、再表示することはできません。ハッシュのみが保存されていたため、元のシークレットを復元することは不可能です。レガシーキーを切り替えるには、アクションメニューをクリックしてRegenerateを選択します。それ以降、新しいシークレットは再表示可能になります。
再表示可能なロール
| Role | Can reveal |
|---|---|
| キーの所有者 | Yes |
| 組織のオーナー / 管理者(組織キーの場合) | Yes |
writeまたはadmin権限を持つチームメンバー |
Yes |
read権限を持つチームメンバー |
No |
キーの編集
任意の行のEditをクリックして、以下を更新します。
- 表示名と説明
- IP許可リスト(1行に1つのIP、任意の送信元IPを許可する場合は空欄のままにします)
- 有効期限(期限を設定しない場合は空欄のままにします)
その他の設定(組織の割り当て、所有者)は編集できません。別の所有権が必要な場合は、新しいキーを作成してください。
有効化と無効化
行にあるDisable / Enableボタンを使用して、キーのステータスを切り替えます。キーを無効化すると、そのキーを使用するすべてのAPIリクエストがブロックされます。いつでも再有効化できます。変更は数秒以内に反映されます。
キーの再生成
キーが漏洩した疑いがある場合は、アクションメニュー(3つの点のボタン)を開き、Regenerateを選択します。これにより、同じキーIDに対して新しいシークレットが作成されます。古いシークレットは即座に機能しなくなります。その他のすべての設定(名前、組織の割り当て、IP許可リスト、有効期限)はそのまま維持されます。
新しいシークレットはダイアログを閉じた後も再表示可能な状態が維持されるため、最初の試行で完全にコピーできなくても問題ありません。
キーの削除
アクションメニューを開き、Deleteを選択します。デフォルトでは、削除によってキーが無効化されます(ソフトデリート)。確認ダイアログから完全に削除することができます。
キーが削除されると、メール通知が届きます。
組織キー
組織の下で作成されたキーは、ロールに基づいて組織メンバーと共有されます。
- オーナーと管理者は、すべての組織キーを表示および編集できます。
- メンバーは、自分が所属するチームに割り当てられているキーのみを表示できます。
組織キーは、作成時に自動的に組織のデフォルトチームに追加されます。
チームを介したキー権限
チームは、誰がどのキーにアクセスできるかを制御します。各チームとキーの割り当てには、権限レベルが設定されます。
| Permission | View key | Reveal | Edit key settings |
|---|---|---|---|
| read | Yes | No | No |
| write | Yes | Yes | Yes |
| admin | Yes | Yes | Yes |
関連情報
- Authentication: APIキーがAPIとどのように連携するか
- Organizations and Teams: 共有アクセスの設定
- Dashboard Overview: すべてのダッシュボードセクション