User methods

Class wandb.apis.public.User

method User.create()

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

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

Arguments

Api

The API instance to use to create the user.

str

The email for the user.

bool | None

Whether this user should be a global instance admin.

Returns

A User object.

method User.delete_api_key()

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

self,
api_key: 'str'

Arguments

str

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

Returns

True on success, false on failure.

method User.generate_api_key()

Generate a new API key.

self,
description: 'str | None' = None

Arguments

str | None

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

Returns

The generated API key (the full secret, not just the name), or None on failure.

W&B Models

W&B Weave

Serverless Inference

Serverless Training

Class wandb.apis.public.User

method User.create()

Arguments

Returns

method User.delete_api_key()

Arguments

Returns

method User.generate_api_key()

Arguments

Returns

​Class wandb.apis.public.User

​method User.create()

Arguments

Returns

​method User.delete_api_key()

Arguments

Returns

​method User.generate_api_key()

Arguments

Returns

Class wandb.apis.public.User

method User.create()

method User.delete_api_key()

method User.generate_api_key()