APIキーは、ユーザーまたはサービスアカウントをW&Bで認証するために使用します。このページでは、W&Bが発行するAPIキーの種類、キーの確認・管理方法、メンバーによるキーの作成と使用を制限する組織設定について説明します。認証情報を管理する組織管理者およびチーム管理者と、自身のキーを管理するメンバーを対象としています。
取得したAPIキーを安全に保存する方法については、APIキーを安全に保存して取り扱うを参照してください。
W&B では、ユーザーとサービスアカウントの両方に APIキーを発行します。
組織管理者、チーム管理者、メンバーは、APIキー タブからキーを管理できます。
Multi-tenant Cloud
専用クラウド と セルフマネージド
-
右上のプロフィールアイコンをクリックし、組織を選択します。
-
https://wandb.ai/account-settings/[ORGANIZATION]/api-keys にアクセスします。[ORGANIZATION] は組織名に置き換えてください。
APIキー タブには、表示権限のあるキーが一覧表示されます。
-
Organization Dashboard にアクセスします。
- 専用クラウド:
https://[ORG-NAME].io/org/dashboard/。[ORG-NAME] は組織名に置き換えてください。
- セルフマネージド:
https://[YOUR-W&B-SERVER-IP]/org/dashboard。[YOUR-W&B-SERVER-IP] はデプロイのIPアドレスに置き換えてください。
-
APIキー タブをクリックします。
このタブには、表示権限のあるキーが一覧表示されます。
Multi-tenant Cloud では、組織ロールが billing admin のユーザーは APIキー タブを表示できません。専用クラウド と セルフマネージド では、このタブは billing ロールによる制限を受けません。
- キー名: キーの作成時に付けた説明的な名前。
- キー ID: 識別に使用されるキーの先頭部分。
- 所有者: キーを所有するユーザーまたはサービスアカウント。
- 最終使用日時: キーが最後にリクエストの認証に使用された日時。
- 作成日時: キーが作成された日時。
セキュリティ上の理由から、表にはキー ID のみが表示されます。W&B では、完全なシークレットキーは作成時に一度だけ表示されます。キーの完全なシークレットが手元にない場合は、キーをローテーションしてください。
- APIキー タブに移動します。
- New key をクリックします。
- キーにわかりやすい名前を付けます。
- Create をクリックします。
- キーをすぐにコピーし、安全な場所に保管します。
W&B がAPIキー全体を表示するのは、作成時の一度だけです。ダイアログを閉じた後は、APIキー全体を再度表示できません。Settings に表示されるのはキーID (キーの先頭部分) のみです。APIキー全体を紛失した場合は、新しいAPIキーを作成する必要があります。
- 表でキーを検索します。
- キーの行の末尾にあるアクションメニューをクリックし、Edit をクリックします。
- 新しい名前を入力し、保存します。
不要になったキーは削除してください。キーが漏洩した可能性がある場合は、直ちに削除してください。
1 つのキーを削除するには、表でキーを見つけ、その行の末尾にあるアクションメニューをクリックし、Delete をクリックして削除を確認します。
複数のキーを一度に削除するには:
- 削除する各キーの横にあるチェックボックスを選択します。
- Delete をクリックします。ボタンには選択したキーの数が表示されます。
- 削除を確認します。
キーを削除すると、そのキーを使用しているすべてのスクリプトまたはサービスのアクセスが直ちに取り消されます。古いキーを削除する前に、システムを更新して置き換え用のキーを使用するようにしてください。
- 新しいAPIキーを作成します。置き換えるキーと区別できる名前を付けます。
- 古いキーを使用するすべてのスクリプト、ジョブ、保存済みシークレットを更新します。保存オプションについては、APIキーを安全に保存および処理するを参照してください。
- ワークロードが新しいキーで認証されることを確認します。
- 古いキーを削除します。
最後の手順を完了するまで、両方のキーが有効です。この重複期間があるため、ダウンタイムなしでローテーションできます。重複期間は短くしてください。
キーが公開された場合は、システムの更新を待たずに直ちに削除してください。公開されたキーは、削除するまで有効なままです。
updateOrganizationPrivacySettings GraphQLミューテーションを使用して設定します。
Enterprise 組織では Multi-tenant Cloud で利用できます。
有効にすると、組織のAPIキーのみで組織のリソースにアクセスできるようになります。メンバーが複数の組織で使用している個人用APIキーは、この組織では使用できなくなります。これにより、他所で漏洩したキーからデータにアクセスされるのを防止できます。
[ORGANIZATION-ID] を組織のIDに置き換えます。
この設定を使用するには、組織のAPIキーがすでに有効になっている必要があります。詳細はW&Bのアカウントチームにお問い合わせください。
APIキーで利用できる機能はデプロイメントタイプによって異なり、Multi-tenant Cloud ではサブスクリプションによっても異なります。次の表に、各機能を利用できる環境を示します。
APIキーを使うとW&Bアカウントにアクセスできるため、パスワードと同様に厳重に保護する必要があります。以下のセクションでは、推奨される保管方法、避けるべき運用、コードにキーを渡す方法、新しいキーに必要なSDKバージョン要件について説明します。
次のいずれかの方法を使用して、APIキーを安全に保管してください。
次のような行為は APIキーの漏えいにつながるおそれがあるため、避けてください。
- APIキーを Git などのバージョン管理システムにコミットしないでください。
- APIキーを平文の設定ファイルに保存しないでください。
- APIキーをコマンドライン引数として渡さないでください。
ps のような OS コマンドの出力に表示されるためです。
- APIキーをメール、チャット、その他の暗号化されていないチャネルで共有しないでください。
- APIキーをソースコードにハードコードしないでください。
APIキーが漏えいした場合は、ただちに W&B アカウントから該当の APIキーを削除し、サポート または担当の AISE に連絡してください。
コード内でAPIキーを使用する場合は、環境変数経由で渡します。
この方法では、キーをソースコードに含めずに済み、必要に応じてローテーションしやすくなります。
ps などの OS コマンドの出力に表示される可能性があるため、環境変数を コマンド と同じ行で設定するのは避けてください。wandbまたはweave SDKで認証すると、APIキーの長さに関するエラーが発生することがあります。
解決策: より新しいバージョンのSDKに更新してください。
-
wandb SDK v0.22.3+
-
weave SDK v0.52.17+
すぐにSDKをアップグレードできない場合は、回避策としてWANDB_API_KEY環境変数でAPIキーを設定してください。 
