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

# Users

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 source
  </a>;

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

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

認証および管理機能を備えた W\&B Users を表すクラスです。

このクラスは、ユーザーの作成、API キーの管理、チーム メンバーシップへのアクセスなど、W\&B Users を管理するためのメソッドを提供します。ユーザー属性を処理するために Attrs から継承しています。

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

```python theme={null}
__init__(client: 'RetryingClient', attrs: 'MutableMapping[str, Any]')
```

**Args:**

* `client`: (`wandb.apis.internal.Api`) 使用するクライアントインスタンス
* `attrs`: (dict) ユーザー属性

**Note:**

> 一部の操作には管理者権限が必要です。

***

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

ユーザーに関連付けられている API キー名のリスト。

**Returns:**
ユーザーに関連付けられている API キーの名前。ユーザーが API キーを持っていない場合、または API キー データが読み込まれていない場合は空のリストを返します。

**Returns:**

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

***

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

ユーザーがメンバーとして所属している Teams 名のリスト。

**Returns:**
ユーザーが所属する Teams の名前。ユーザーがチームメンバーシップを持っていない場合、またはチームデータが読み込まれていない場合は空のリストを返します。

**Returns:**

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

***

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

ユーザーの資格情報を使用した API のインスタンス。

**Returns:**

* `Api | None`: user\_api プロパティの値。

***

### <kbd>classmethod</kbd> `User.create`

```python theme={null}
create(api: 'Api', email: 'str', admin: 'bool' = False) → Self
```

新しいユーザーを作成します。

**Args:**

* `api` (`Api`): 使用する API インスタンス
* `email` (str): チームの名前
* `admin` (bool): このユーザーをグローバルなインスタンス管理者にするかどうか

**Returns:**
`User` オブジェクト

***

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

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

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

**Args:**

* `api_key` (str): 削除する API キーの名前。これは `api_keys` プロパティによって返される名前のいずれかである必要があります。

**Returns:**
成功したかどうかを示すブール値

**Raises:**
api\_key が見つからない場合は ValueError

***

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

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

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

**Args:**

* `description` (str, optional): 新しい API キーの説明。これは API キーの目的を特定するために使用できます。

**Returns:**
新しい API キー。失敗した場合は None
