> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# APIキーを管理する

> W&B APIキーの検索、作成、削除、および組織のメンバーによるAPIキーの作成と使用の制限を行います。

APIキーは、ユーザーまたはサービスアカウントをW\&Bで認証するために使用します。このページでは、W\&Bが発行するAPIキーの種類、キーの確認・管理方法、メンバーによるキーの作成と使用を制限する組織設定について説明します。認証情報を管理する組織管理者およびチーム管理者と、自身のキーを管理するメンバーを対象としています。

取得したAPIキーを安全に保存する方法については、[APIキーを安全に保存して取り扱う](#store-and-handle-api-keys-securely)を参照してください。

<div id="types-of-api-keys">
  ## APIキーの種類
</div>

W\&B では、ユーザーとサービスアカウントの両方に APIキーを発行します。

| キータイプ                                                                                            | 所有者       | アクセス            |
| ------------------------------------------------------------------------------------------------ | --------- | --------------- |
| 個人用 APIキー                                                                                        | ユーザー      | ユーザーが所属するすべての組織 |
| [チームサービスアカウント](/ja/platform/hosting/iam/service-accounts#team-scoped-service-accounts) キー        | サービスアカウント | 1 つのチーム         |
| [組織サービスアカウント](/ja/platform/hosting/iam/service-accounts#organization-scoped-service-accounts) キー | サービスアカウント | 組織内のすべてのチーム     |

<div id="find-and-manage-api-keys">
  ## APIキーを検索して管理する
</div>

組織管理者、チーム管理者、メンバーは、**APIキー** タブからキーを管理できます。

<Tabs>
  <Tab title="Multi-tenant Cloud">
    1. 右上のプロフィールアイコンをクリックし、組織を選択します。
    2. `https://wandb.ai/account-settings/[ORGANIZATION]/api-keys` にアクセスします。`[ORGANIZATION]` は組織名に置き換えてください。

       **APIキー** タブには、表示権限のあるキーが一覧表示されます。
  </Tab>

  <Tab title="専用クラウド と セルフマネージド">
    1. **Organization Dashboard** にアクセスします。
       * **専用クラウド**: `https://[ORG-NAME].io/org/dashboard/`。`[ORG-NAME]` は組織名に置き換えてください。
       * **セルフマネージド**: `https://[YOUR-W&B-SERVER-IP]/org/dashboard`。`[YOUR-W&B-SERVER-IP]` はデプロイのIPアドレスに置き換えてください。
    2. **APIキー** タブをクリックします。

       このタブには、表示権限のあるキーが一覧表示されます。
  </Tab>
</Tabs>

自分の個人用APIキーのみを確認するには、プロフィールアイコンをクリックして **User Settings** をクリックし、**APIキー** までスクロールします。詳細は、[User settings](/ja/platform/app/settings-page/user-settings#api-keys)を参照してください。

<Note>
  Multi-tenant Cloud では、組織ロールが billing admin のユーザーは **APIキー** タブを表示できません。専用クラウド と セルフマネージド では、このタブは billing ロールによる制限を受けません。
</Note>

<div id="key-visibility-by-role">
  ### ロール別のキーの表示範囲
</div>

**APIキー** タブに表示されるキーは、ロールによって異なります。

| ロール           | 表示できるキー                                                                                                 |
| ------------- | ------------------------------------------------------------------------------------------------------- |
| Member        | 自身の組織の APIキー                                                                                            |
| チーム管理者        | 自身の組織の APIキー、および管理しているチームのサービスアカウントのキー                                                                  |
| 組織管理者         | 組織のサービスアカウントキーを含む、組織内のすべての APIキー                                                                        |
| Billing admin | Multi-tenant Cloud では、キーは表示されません。このロールでは **APIキー** タブが非表示になります。専用クラウドおよびセルフマネージドでは、Member と同じキーが表示されます。 |

<div id="read-the-api-keys-table">
  ### APIキーの表を確認する
</div>

表には、各キーに関する次の列が表示されます。

* **キー名**: キーの作成時に付けた説明的な名前。
* **キー ID**: 識別に使用されるキーの先頭部分。
* **所有者**: キーを所有するユーザーまたはサービスアカウント。
* **最終使用日時**: キーが最後にリクエストの認証に使用された日時。
* **作成日時**: キーが作成された日時。

<Note>
  セキュリティ上の理由から、表にはキー ID のみが表示されます。W\&B では、完全なシークレットキーは作成時に一度だけ表示されます。キーの完全なシークレットが手元にない場合は、[キーをローテーションしてください](#rotate-an-api-key)。
</Note>

リストを絞り込むには、検索フィールドにキー名、キー ID、または所有者を入力するか、**フィルター**をクリックしてキータイプなどの属性でフィルタリングします。

<div id="create-an-api-key">
  ### APIキーを作成する
</div>

1. **APIキー** タブに移動します。
2. **New key** をクリックします。
3. キーにわかりやすい名前を付けます。
4. **Create** をクリックします。
5. キーをすぐにコピーし、安全な場所に保管します。

<Warning>
  W\&B がAPIキー全体を表示するのは、作成時の一度だけです。ダイアログを閉じた後は、APIキー全体を再度表示できません。Settings に表示されるのはキーID (キーの先頭部分) のみです。APIキー全体を紛失した場合は、新しいAPIキーを作成する必要があります。
</Warning>

Multi-tenant Cloud では、このタブから作成したキーは、現在表示している組織に属します。利用する組織ごとに個別のキーを作成してください。

<div id="rename-an-api-key">
  ### APIキーの名前を変更する
</div>

キーの用途がわかる名前に変更しておくと、後で見慣れないキーを特定しやすくなります。名前を変更してもキーのシークレットは変わらず、そのキーを使用しているものが中断されることもありません。

1. 表でキーを検索します。
2. キーの行の末尾にあるアクションメニューをクリックし、**Edit** をクリックします。
3. 新しい名前を入力し、保存します。

<div id="delete-api-keys">
  ### APIキーを削除する
</div>

不要になったキーは削除してください。キーが漏洩した可能性がある場合は、直ちに削除してください。

1 つのキーを削除するには、表でキーを見つけ、その行の末尾にあるアクションメニューをクリックし、**Delete** をクリックして削除を確認します。

複数のキーを一度に削除するには:

1. 削除する各キーの横にあるチェックボックスを選択します。
2. **Delete** をクリックします。ボタンには選択したキーの数が表示されます。
3. 削除を確認します。

<Warning>
  キーを削除すると、そのキーを使用しているすべてのスクリプトまたはサービスのアクセスが直ちに取り消されます。古いキーを削除する前に、システムを更新して置き換え用のキーを使用するようにしてください。
</Warning>

<div id="rotate-an-api-key">
  ### APIキーをローテーションする
</div>

セキュリティポリシーに沿ったスケジュールでキーをローテーションし、キーが漏洩した可能性がある場合は直ちにローテーションしてください。キーを使用するワークロードを継続して実行する必要がある場合は、キーを削除するのではなくローテーションしてください。

W\&B には、単一のローテーション操作はありません。キーのシークレット全体は作成時にのみ表示されるため、キーを置き換えることでローテーションします。

1. 新しいAPIキーを作成します。置き換えるキーと区別できる名前を付けます。
2. 古いキーを使用するすべてのスクリプト、ジョブ、保存済みシークレットを更新します。保存オプションについては、[APIキーを安全に保存および処理する](#store-and-handle-api-keys-securely)を参照してください。
3. ワークロードが新しいキーで認証されることを確認します。
4. 古いキーを削除します。

最後の手順を完了するまで、両方のキーが有効です。この重複期間があるため、ダウンタイムなしでローテーションできます。重複期間は短くしてください。

<Warning>
  キーが公開された場合は、システムの更新を待たずに直ちに削除してください。公開されたキーは、削除するまで有効なままです。
</Warning>

<div id="restrict-how-members-use-api-keys">
  ## メンバーによるAPIキーの使用を制限する
</div>

組織管理者は、APIキーの作成と使用を制限できます。利用できる制限はデプロイメントタイプによって異なり、各制限はW\&B Appではなく、`updateOrganizationPrivacySettings` GraphQLミューテーションを使用して設定します。

<div id="require-organization-api-keys">
  ### 組織のAPIキーを必須にする
</div>

Enterprise 組織では **Multi-tenant Cloud** で利用できます。

有効にすると、組織のAPIキーのみで組織のリソースにアクセスできるようになります。メンバーが複数の組織で使用している個人用APIキーは、この組織では使用できなくなります。これにより、他所で漏洩したキーからデータにアクセスされるのを防止できます。

`[ORGANIZATION-ID]` を組織のIDに置き換えます。

```graphql theme={null}
mutation RequireOrgScopedAPIKeys {
  updateOrganizationPrivacySettings(
    input: {organizationId: "[ORGANIZATION-ID]", requireOrgScopedAPIKeys: true}
  ) {
    success
  }
}
```

この設定を使用するには、組織のAPIキーがすでに有効になっている必要があります。詳細はW\&Bのアカウントチームにお問い合わせください。

<div id="availability">
  ## 利用可能性
</div>

APIキーで利用できる機能はデプロイメントタイプによって異なり、Multi-tenant Cloud ではサブスクリプションによっても異なります。次の表に、各機能を利用できる環境を示します。

| 機能                    | Multi-tenant Cloud | 専用クラウド   | セルフマネージド |
| --------------------- | ------------------ | -------- | -------- |
| APIキーの表を検索・フィルタリングする  | Yes                | v0.84.0+ | v0.84.0+ |
| **APIキー** タブからキーを作成する | Enterprise 組織      | v0.84.0+ | v0.84.0+ |
| 複数のキーを一度に削除する         | Enterprise 組織      | v0.84.0+ | v0.84.0+ |
| APIキーの作成を無効にする        | 利用不可               | v0.84.0+ | v0.84.0+ |

<div id="store-and-handle-api-keys-securely">
  ## APIキーを安全に保管・管理する
</div>

APIキーを使うとW\&Bアカウントにアクセスできるため、パスワードと同様に厳重に保護する必要があります。以下のセクションでは、推奨される保管方法、避けるべき運用、コードにキーを渡す方法、新しいキーに必要なSDKバージョン要件について説明します。

<div id="recommended-storage-methods">
  ### 推奨される保管方法
</div>

次のいずれかの方法を使用して、APIキーを安全に保管してください。

* **シークレットマネージャー**: [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/)、[HashiCorp Vault](https://developer.hashicorp.com/vault)、[Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault)、[Google Secret Manager](https://cloud.google.com/security/products/secret-manager) などの専用のシークレット管理システムを使用してください。
* **パスワードマネージャー**: 信頼できるパスワードマネージャーアプリを使用してください。
* **OS レベルのキーチェーン**: macOS Keychain、Windows Credential Manager、または Linux Secret Service にキーを保存します。本番環境での使用は推奨されません。

<div id="what-to-avoid">
  ### 避けるべきこと
</div>

次のような行為は APIキーの漏えいにつながるおそれがあるため、避けてください。

* APIキーを Git などのバージョン管理システムにコミットしないでください。
* APIキーを平文の設定ファイルに保存しないでください。
* APIキーをコマンドライン引数として渡さないでください。`ps` のような OS コマンドの出力に表示されるためです。
* APIキーをメール、チャット、その他の暗号化されていないチャネルで共有しないでください。
* APIキーをソースコードにハードコードしないでください。

APIキーが漏えいした場合は、ただちに W\&B アカウントから該当の APIキーを削除し、[サポート](mailto:support@wandb.ai) または担当の AISE に連絡してください。

<div id="environment-variables">
  ### 環境変数
</div>

コード内でAPIキーを使用する場合は、環境変数経由で渡します。

```bash theme={null}
export WANDB_API_KEY="[YOUR-API-KEY]"
```

この方法では、キーをソースコードに含めずに済み、必要に応じてローテーションしやすくなります。

<Warning>
  `ps` などの OS コマンドの出力に表示される可能性があるため、環境変数を コマンド と同じ行で設定するのは避けてください。

  ```bash theme={null}
  # APIキーがプロセスマネージャーに露出するおそれがあるため、このパターンは避けてください
  export WANDB_API_KEY="[YOUR-API-KEY]" ./my-script.sh
  ```
</Warning>

<div id="sdk-version-compatibility">
  ### SDKのバージョン互換性
</div>

新しいAPIキーを使用する場合は、お使いのSDKバージョンがそのAPIキーをサポートしていることを確認してください。新しいAPIキーは、従来のキーより長くなっています。古いバージョンの`wandb`または`weave` SDKで認証すると、APIキーの長さに関するエラーが発生することがあります。

**解決策**: より新しいバージョンのSDKに更新してください。

* `wandb` SDK v0.22.3+

  ```bash theme={null}
  pip install --upgrade wandb==0.22.3
  ```
* `weave` SDK v0.52.17+

  ```bash theme={null}
  pip install --upgrade weave==0.52.17
  ```

すぐにSDKをアップグレードできない場合は、回避策として`WANDB_API_KEY`環境変数でAPIキーを設定してください。