Passer au contenu principal

class User

Un utilisateur sur une instance W&B. Cette classe permet de gérer les clés API d’un utilisateur et d’accéder à des informations telles que les Teams auxquelles il appartient. La méthode de classe create peut être utilisée pour créer un nouvel utilisateur. Arguments :
  • client: Le client GraphQL à utiliser pour les opérations réseau.
  • attrs: Un sous-ensemble du type User dans le schéma GraphQL.

propriété User.api_keys

Noms des clés API de l’utilisateur. Cette propriété renvoie les noms des clés API, et non le secret associé à chaque clé. Le nom d’une clé ne peut pas être utilisé comme clé API. La liste est vide si l’utilisateur n’a pas de clés API ou si celles-ci n’ont pas été chargées. Retourne :
  • list[str]: La valeur de propriété api_keys.

propriété User.teams

Noms des Teams auxquelles l’utilisateur appartient. Il s’agit d’une liste vide si l’utilisateur n’appartient à aucune équipe ou si les données des Teams n’ont pas été chargées. Retourne :
  • list[str]: La valeur de la propriété Teams.

propriété User.user_api

Une instance wandb.Api qui utilise les identifiants de l’utilisateur. Retourne :
  • Api | None : La valeur de la propriété user_api.

méthode User.delete_api_key

delete_api_key(api_key: 'str') → bool
Supprime une clé API d’un utilisateur. Seul le propriétaire de la clé ou un administrateur peut la supprimer. Arguments :
  • api_key: Le nom de la clé API à supprimer. Utilisez l’un des noms renvoyés par la propriété api_keys.
Retourne : True en cas de succès, false en cas d’échec.

méthode User.generate_api_key

generate_api_key(description: 'str | None' = None) → str | None
Générez une nouvelle clé API. Arguments :
  • description : Une description de la nouvelle clé API. Elle peut être utilisée pour identifier l’usage de la clé API.
Retourne : La clé API générée (le secret complet, pas seulement le nom), ou None en cas d’échec.