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

# User

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <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 compact url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/users.py#L26" />

## <Badge color="yellow" size="lg" shape="rounded">Class</Badge> wandb.apis.public.User

A user on a W\&B instance.

This allows managing a user's API keys and accessing information like
team memberships. The `create` class method can be used to create a new
user.

## Properties

<ResponseField name="api_keys" type="list[str]">
  Names of the user's API keys.

  This property returns the names of the the API keys, *not* the secret
  associated with the key. The name of the key cannot be used as an API
  key.

  The list is empty if the user has no API keys or if API keys have not
  been loaded.
</ResponseField>

<ResponseField name="teams" type="list[str]">
  Names of the user's teams.

  This is an empty list if the user has no team memberships or if teams
  data was not loaded.
</ResponseField>

<ResponseField name="user_api" type="Api | None">
  A `wandb.Api` instance using the user's credentials.
</ResponseField>

## Methods

### <Badge color="blue" size="lg" shape="rounded">method</Badge> User.create()

```python theme={null}
api: 'Api',
email: 'str',
admin: 'bool | None' = False
```

Create a new user.

This is an internal method. Use the `create_user()` method of
`wandb.Api` instead.

##### Arguments

<ResponseField name="api" type="Api">
  The API instance to use to create the user.
</ResponseField>

<ResponseField name="email" type="str">
  The email for the user.
</ResponseField>

<ResponseField name="admin" type="bool | None">
  Whether this user should be a global instance admin.
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">method</Badge> User.delete\_api\_key()

```python theme={null}
self,
api_key: 'str'
```

Delete a user's API key.

Only the owner of the key or an admin can delete it.

##### Arguments

<ResponseField name="api_key" type="str">
  The name of the API key to delete. Use one of the names returned by the `api_keys` property.
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">method</Badge> User.generate\_api\_key()

```python theme={null}
self,
description: 'str | None' = None
```

Generate a new API key.

##### Arguments

<ResponseField name="description" type="str | None">
  A description for the new API key. This can be used to identify the purpose of the API key.
</ResponseField>
