API キー タブでは、API キーを生成してラベル付けし、プラットフォームの機能にプログラムから接続できます。これらのキーを使用して、他のサービスとの接続を確立および維持します。API キーを定期的にレビューし、不要になったものを削除することをお勧めします。これにより、不正アクセスからプロジェクトを保護できます。
API キーはプロジェクト固有のもので、プロジェクトリソースへのアクセスを提供します。安全に保管し、定期的にローテーションしてください。
API キー一覧
API キー一覧には、このプロジェクト用に作成されたすべてのキーが表示されます。名前またはキーで検索 フィールドを使用して特定のキーを検索します。各エントリには以下の列が表示されます:
| 列 | 説明 |
|---|
| 名前 | API キーに割り当てられた名前で、タイプ(特権 または システム)を示すバッジが付いています。 |
| API キー | キー値の短縮プレビューです。コピーアイコンを使用して完全なキーをクリップボードにコピーします。 |
| 作成日時 | キーが作成された日時です。 |
| アクション | ユーザーが作成したキーには 削除 リンクがあります。システムキーは 保護 と表示され、削除できません。 |
キータイプ
新しい API キーを作成する際は、以下のキータイプから 1 つを選択する必要があります:
| タイプ | 説明 |
|---|
| 特権キー | プロジェクトへの完全なアクセス権です。チャットの送信、プロジェクトリソース、エージェント、ワークフロー、設定の編集や削除ができます。信頼できるインテグレーションやサーバー間自動化に使用してください。 |
| 閲覧限定キー | プロジェクトへの読み取り専用アクセスとチャットランタイム(ボットインタラクション)が可能です。プロジェクトリソース、エージェント、ワークフロー、設定の編集や削除はできません。Teams やチャネルボット認証など、限定的な範囲での配布を想定しています。 |
新しい API キーの作成
API キー作成フォームを開く
設定 → API キー タブで、API キーを作成 ボタンを選択します。
キータイプを選択
必要なアクセスレベルに応じて、特権キー または 閲覧限定キー を選択します。
キーに名前を付ける
キー名 フィールドに、キーの目的を明確に示す説明的な名前を入力します。
キーを生成
生成 ボタンを選択します。キーが作成され、API キー一覧に表示されます。
生成直後に API キーをコピーし、安全に保管してください。完全なキー値が再表示されない場合があります。
API キーの削除
Automator キー は、すべてのプロジェクトに自動的に作成されるシステムキーで、削除できません。それ以外のすべての API キーは、必要に応じて削除できます。
- 設定 → API キー タブで、削除するキーの 削除 リンクを選択します。
- ポップアップで削除を確認します。
削除が完了したことを示すメッセージが表示され、キーは一覧に表示されなくなります。
ベストプラクティス
- 適切なキータイプを使用する: 特権キーは信頼できるサーバーサイドのインテグレーションにのみ使用してください。パブリック向けやチャネルボットのデプロイメントには閲覧限定キーを使用してください。
- 明確な命名: キーの目的と所属するインテグレーションを明確に示す説明的な名前を使用してください。
- 定期的なローテーション: 不正アクセスのリスクを軽減するため、定期的にキーを削除して再生成してください。