> ## 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.

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

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

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

A class representing a W\&B user with authentication and management capabilities.

This class provides methods to manage W\&B users, including creating users, managing API keys, and accessing team memberships. It inherits from Attrs to handle user attributes.

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

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

**Args:**

* `client`:  (`wandb.apis.internal.Api`) The client instance to use
* `attrs`:  (dict) The user attributes

**Note:**

> Some operations require admin privileges

***

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

List of API key names associated with the user.

**Returns:**
Names of API keys associated with the user. Empty list if user  has no API keys or if API key data hasn't been loaded.

**Returns:**

* `list[str]`: The api\_keys property value.

***

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

List of team names that the user is a member of.

**Returns:**
Names of teams the user belongs to. Empty list if user has no  team memberships or if teams data hasn't been loaded.

**Returns:**

* `list[str]`: The teams property value.

***

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

An instance of the api using credentials from the user.

**Returns:**

* `Api | None`: The user\_api property value.

***

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

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

Create a new user.

**Args:**

* `api` (`Api`):  The api instance to use
* `email` (str):  The name of the team
* `admin` (bool):  Whether this user should be a global instance admin

**Returns:**
A `User` object

***

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

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

Delete a user's api key.

**Args:**

* `api_key` (str):  The name of the API key to delete. This should be  one of the names returned by the `api_keys` property.

**Returns:**
Boolean indicating success

**Raises:**
ValueError if the api\_key couldn't be found

***

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

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

Generate a new api key.

**Args:**

* `description` (str, optional):  A description for the new API key. This can be  used to identify the purpose of the API key.

**Returns:**
The new api key, or None on failure
