Skip to main content

Documentation Index

Fetch the complete documentation index at: https://wb-21fd5541-python-sdk-testing.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

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.

​
Args:

  • client: The GraphQL client to use for network operations.
  • attrs: A subset of the User type in the GraphQL schema.
  • api_key: An optional API key for the user, used to create a wandb.Api instance for the user. This is required for some operations, such as generating new API keys for the user.

​
Properties:

​
user_api

A wandb.Api instance using the user’s credentials.

​
api_keys

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.

​
teams

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.

​
Methods:

​
create

Create a new user. This is an internal method. Use the create_user() method of wandb.Api instead.

​
delete_api_key

Delete a user’s API key. Only the owner of the key or an admin can delete it.

​
display

Display this object in jupyter.

​
generate_api_key

Generate a new API key.