> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-run-filter-ui-updates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# User

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/users.py" />

## <kbd>class</kbd> `User`

W\&B インスタンス上のユーザー。

このクラスでは、ユーザーの APIキーを管理し、Teams への所属情報などにアクセスできます。`create` クラスメソッドを使用して、新しいユーザーを作成できます。

**引数:**

* `client`:  ネットワーク操作に使用する GraphQL クライアント。
* `attrs`:  GraphQL スキーマ内の User タイプのサブセット。

### <kbd>property</kbd> User.api\_keys

ユーザーのAPIキーの名前。

このプロパティが返すのはAPIキーの名前であり、キーに関連付けられたシークレットそのものでは*ありません*。キーの名前をAPIキーとして使用することはできません。

ユーザーがAPIキーを持っていない場合、またはAPIキーが読み込まれていない場合、このリストは空です。

**戻り値:**

* `list[str]`: api\_keys プロパティの値。

***

### <kbd>property</kbd> User.teams

ユーザーが所属するTeamsの名前。

ユーザーがどのTeamsにも所属していない場合、またはTeamsデータが読み込まれていない場合、これは空のリストになります。

**戻り値:**

* `list[str]`: teamsプロパティの値。

***

### <kbd>property</kbd> User.user\_api

ユーザーの認証情報を使用する `wandb.Api` インスタンス。

**戻り値:**

* `Api | None`: `user_api` プロパティの値。

***

### <kbd>method</kbd> `User.delete_api_key`

```python theme={null}
delete_api_key(api_key: 'str') → bool
```

ユーザーのAPIキーを削除します。

キーの所有者または管理者のみが削除できます。

**引数:**

* `api_key`:  削除するAPIキーの名前。`api_keys` プロパティから返される名前のいずれかを使用してください。

**戻り値:**
成功時はTrue、失敗時はfalseです。

***

### <kbd>method</kbd> `User.generate_api_key`

```python theme={null}
generate_api_key(description: 'str | None' = None) → str | None
```

新しいAPIキーを生成します。

**引数:**

* `description`: 新しいAPIキーの説明。APIキーの用途を判別するために使用できます。

**戻り値:**
生成されたAPIキー (名前だけでなく、完全なシークレット) 、または失敗した場合は None。
