APIキーの作成と保護

スコープとロール

API Keysには、アカウント閲覧、AI推論とトレーニング、AIホスティングジョブ、モデル変換ジョブ、ブロックチェーンサービス、サポートチケット権限など、対応するスコープの説明が表示されます。組織ではオーナーと管理者がキーを管理でき、メンバーは閲覧のみ可能です。認証情報の表示範囲と権限はコンテキストに紐付くため、キーを所属させる場所を選んでください。

1. API Keysを開く前に、対象の組織を選択します。
2. スコープの説明を読み、必要な操作だけを選びます。
3. 管理できない場合は、オーナーまたは管理者に依頼します。

本番用キーの作成

通常のキーには、2～120文字の名前、一覧にあるスコープを1つ以上、任意のIP許可リストが必要です。有効なIPアドレスまたはCIDRネットワークを1行ずつ、画面に示された上限内で入力します。リストが空の場合は、どの送信元IPからも利用できます。作成後、キー全文が表示されるのは一度だけです。保存されるのはハッシュのみで、後から元の値を取得することはできません。

1. アプリケーション名または環境名をキー名にします。
2. 必要最小限のスコープと、必要な固定送信元アドレスを選びます。
3. 表示された値を、承認済みのシークレット保管先へ直接保存します。

サンドボックス推論キー

ダッシュボードでは、AI推論と画面に表示される月間リクエスト上限だけに制限したサンドボックスキーを作成できます。アカウントまたは組織の各コンテキストで有効にできるサンドボックスキーは1つだけです。既存のキーがある場合は、それを使用するか、置き換える前に失効させます。サンドボックスと本番の認証情報は分けて管理してください。サンドボックスの利用枠を本番サービスの保証として扱わないでください。

1. このコンテキストで有効なサンドボックスキーがあるか確認します。
2. 推論のテスト用にキーを作成し、本番キーとは別に保管します。
3. 利用枠を確認し、不要になったキーは失効させます。

シークレットを保護する

キー全文をコピーできるのは、作成またはローテーション時に表示される間だけです。利用するサービスだけがアクセスできる暗号化済みシークレット管理ツールに保存してください。ソースコード、ブラウザー側のコード、ログ、スクリーンショット、チケット、チャットに記載してはいけません。一度限りの表示を見逃した場合や値が見つからない場合はキーをローテーションします。サポートでも平文のキーは取得できません。

1. 表示された値を保護された保管先へ直接移します。
2. ドキュメントに記載された設定を使って利用側のサービスを構成します。
3. 漏えいや紛失が疑われる場合は、直ちにローテーションします。

ローテーションまたは失効

ローテーションすると旧キーが失効し、同じ名前、ティア、スコープ、許可リストの新しいキーが作成されます。新しい値が表示されるのは一度だけです。旧キーは使えなくなるため、依存するサービスを速やかに更新してください。失効はキーを置き換えずに無効化します。どちらの操作も、送信前に対象のキーとコンテキストを確認してください。

1. 通常のローテーション前に、利用中のすべてのサービスを特定します。
2. 新しい値を保管し、依存サービスを更新します。
3. 不要になったキーを失効させ、ダッシュボード上の状態を確認します。

リクエスト拒否の原因を調べる

キーの形式が不正、キーが失効済み、ユーザーが無効、送信元IPが許可リスト外、必要なスコープがない場合、リクエストが拒否されます。サンドボックスでは月間上限超過も原因になります。コンテキスト、配備済みシークレットのバージョン、呼び出し元の送信元アドレス、必要なスコープを確認します。問い合わせ時にシークレットを伝えてはいけません。

1. キーが有効で、操作に必要なスコープを含むことを確認します。
2. 実際の送信元IPとサンドボックスの利用枠を確認します。
3. 値が誤っている、または漏えた場合はローテーションし、共有する情報は伏せてください。

よくある質問

関連ページ

• 注文前に料金を確認する
• 注文の申し込みと進捗確認
• サブスクリプションと請求の確認
• 顧客向けWebhookの設定
• 組織メンバーシップの管理
• 通知の管理
• プロフィール、セキュリティ、プライバシーの管理