APIキーの管理
API Keysページでは、アプリケーションがFourA APIを呼び出すために使用するキーの作成、表示、および管理を行うことができます。
キーの表示
このページには、アクセス可能なすべてのキーが表示されます。
- 自身で直接作成した個人キー。
- 組織の所有者または管理者である場合、または自分が所有するキーが組織に転送された場合の組織キー。
テーブルの各行には以下が表示されます。
| 列 | 内容 |
|---|---|
| Name | 表示名と説明(任意) |
| Key | マスクされたプレフィックス(例: pk_live_••••••••)と、その横にあるReveal(表示)ボタン |
| Owner | 個人キーの場合はPersonal、組織所有キーの場合は組織名 |
| Status | Active または Inactive |
| Created | キーが作成された日時 |
| Last Used | キーが最後にリクエストを行った日時 |
検索ボックスを使用して名前や説明でフィルタリングし、ステータスフィルターを使用してアクティブまたは非アクティブなキーのみを表示します。すべての列見出しは並べ替え可能です。
キーの作成
Create Keyをクリックし、以下を入力します。
| フィールド | 必須 | 説明 |
|---|---|---|
| Name | はい | わかりやすいラベル(例: "production-scraper" または "staging-test") |
| Description | いいえ | このキーの用途に関するメモ |
| Owner | 組織に所属している場合は「はい」 | 個人(Personal)、または所属する組織のいずれか。ピッカーは少なくとも1つの組織に所属している場合にのみ表示されます。 |
作成直後に一度だけ、コピー可能なダイアログに完全なキーが表示されます。後でRevealを使用して再度表示することもできます(下記参照)。
キーはpk_live_プレフィックスを使用し、pk_live_a1b2c3d4e5f6...のようになります。新しいキーが作成されると、確認のメールが送信されます。
キーの表示
キーのマスクされたプレフィックスの横にある目のアイコンをクリックすると、シークレット全体を再度表示できます。ダッシュボードで確認を求められた後、プレーンテキストのキー、コピーボタン、および短いカウントダウンを含むダイアログが開きます。カウントダウン後、ダイアログはページからシークレットを消去します。
ライブのクレデンシャルが公開されるため、すべての表示操作は監査ログに記録されます。
レガシーキー
表示機能がリリースされる前に作成されたキーは、目のアイコンの代わりにロックアイコンが表示され、表示することはできません。ハッシュのみが保存されていたため、元のシークレットは復元不可能です。レガシーキーを切り替えるには、アクションメニューをクリックしてRegenerateを選択します。それ以降、新しいシークレットは表示可能になります。
表示できるユーザー
| ロール | 表示の可否 |
|---|---|
| キーの所有者 | はい |
| 組織の所有者または管理者(組織所有キーの場合) | はい |
| その他のユーザー | いいえ |
キーの編集
任意の行のEditをクリックして、表示名と説明を更新します。所有権(個人または組織)はここでは変更されません。キーを所有者間で移動するには、後述のTransferを使用します。
アクティベートと非アクティベート
行にあるDisableまたはEnableボタンを使用して、キーのステータスを切り替えます。キーを非アクティブ化すると、そのキーを使用するすべてのAPIリクエストがブロックされます。いつでも再アクティブ化できます。変更は数秒以内に適用されます。
キーの再生成
キーが侵害された疑いがある場合は、アクションメニュー（3点ボタン）を開き、Regenerateを選択します。これにより、同じキーIDに対して新しいシークレットが作成されます。古いシークレットは直ちに無効になります。名前、組織の割り当て、その他の設定はそのまま保持されます。
新しいシークレットはダイアログを閉じた後も表示可能なままになるため、最初の試行で完璧にコピーする必要はありません。
キーの転送
各行のメニューにはTransferアクションがあります。これを使用して、シークレットを再生成せずに、キーを個人と組織の所有権の間で移動します。キーID、そのメトリクス、およびアクティビティ履歴は保持され、所有者のみが変更されます。
よくあるケース:
- 共有プロジェクト用に作成した個人キーを組織に移動し、後でチームメイトが管理できるようにする。
- プロジェクトがスピンアウトした場合に、組織のキーを自分自身に再割り当てする。
自分が所有するキー（個人）は、自分がオーナーまたは管理者である任意の組織に転送できます。また、管理している組織のキーを自分自身に、または管理している組織間で転送できます。
キーの削除
アクションメニューを開き、Deleteを選択します。以前に使用したキーを削除すると論理削除されます。つまり、キーの認証は停止しますが、アクティビティとメトリクスの履歴はそのまま残ります。一度も使用されていないキーは物理削除できます。
キーが削除されると、メール通知が届きます。
組織のキー
組織が所有するキーは、組織のオーナーと管理者に表示されます。オーナーまたは管理者のロールを持たないメンバーには表示されません。
組織が所有するキーの使用量は、組織のオーナーのプランにカウントされます。
関連情報
- Authentication: APIキーとAPIの連携方法
- Organizations and Teams: 共有アクセスの設定
- Dashboard Overview: ダッシュボードの全セクション