User

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

property user_api

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

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

property 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

method create

api: 'Api',
email: 'str',
admin: 'bool' = False

Create a new user.

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

Arguments

• api: The API instance to use to create the user.
• email: The email for the user.
• admin: Whether this user should be a global instance admin.

method delete_api_key

self,
api_key: 'str'

Delete a user’s API key.

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

Arguments

• api_key: The name of the API key to delete. Use one of the names returned by the api_keys property.

method display

self, height=420, hidden=False

Display this object in jupyter.

Arguments

• height:
• hidden:

method generate_api_key

self,
description: 'str | None' = None

Generate a new API key.

Arguments

• description: A description for the new API key. This can be used to identify the purpose of the API key.