APIキーを作成して失効させる

キーを作成する

1. API Keysを開きます。
2. Create keyを選択します。
3. 説明用のNameを入力し、キーの有効期限を選択します。
4. Restrict keyを有効のままにして、連携に必要なエンドポイント権限だけを選択します。同じAPI領域では、書き込み権限に読み取り権限も含まれます。
5. 既知のアドレスからのリクエストに限定する場合は、Restrict by IP addressを有効にし、許可するIPアドレスまたはCIDR範囲を追加します。
6. Create keyを選択します。

ダイアログを閉じる前に、API Keyダイアログに表示されたシークレットをコピーしてください。Threetoneでそのシークレットが再表示されることはありません。サーバー側のシークレットマネージャーまたは環境変数に保存し、ソース管理へのコミットやブラウザーコードへの埋め込みは絶対にしないでください。

ユーザーAPIキーは作成したアカウントに属します。ワークスペースが所有する認証情報が必要な場合は、Service Accountsの領域を使ってください。

キーを失効させる

API Keysページで対象のキーの失効操作を選び、名前とマスクされた値を確認してからRevoke keyを選択します。失効は取り消せず、そのキーを使ったリクエストはすぐに失敗するようになります。

そのキーを使っていたすべてのサービスを更新してください。シークレット保管場所、デプロイ設定、ローカル開発環境から、失効した値を削除します。