Types de clés API
W&B délivre des clés API aussi bien aux personnes qu’aux comptes de service.Trouver et gérer les clés API
Les administrateurs de l’organisation, les administrateurs d’équipe et les membres gèrent les clés depuis l’onglet API Keys.- Cloud mutualisé
- Cloud dédié et autogéré
- Cliquez sur l’icône de votre profil en haut à droite, puis sélectionnez votre organisation.
-
Accédez à
https://forge.coreweave.com/account-settings/[ORGANIZATION]/api-keys. Remplacez[ORGANIZATION]par le nom de votre organisation. L’onglet API Keys répertorie les clés que vous êtes autorisé à voir.
Dans le Cloud mutualisé, les utilisateurs ayant le rôle d’administrateur de la facturation dans l’organisation ne peuvent pas voir l’onglet API Keys. Dans le Cloud dédié et les déploiements autogérés, l’accès à cet onglet ne dépend pas du rôle de facturation.
Visibilité des clés selon le rôle
Les clés affichées dans l’onglet API Keys dépendent de votre rôle :Lire le tableau des clés API
Le tableau répertorie chaque clé avec les colonnes suivantes :- Key name : le nom descriptif attribué à la clé lors de sa création.
- Key ID : la première partie de la clé, qui sert à l’identifier.
- Owner : l’utilisateur ou le compte de service propriétaire de la clé.
- Last used : la date à laquelle la clé a authentifié une requête pour la dernière fois.
- Created on : la date de création de la clé.
Pour des raisons de sécurité, le tableau n’affiche que l’identifiant de la clé. W&B n’affiche la clé secrète complète qu’une seule fois, lors de sa création. Si vous ne disposez plus du secret complet d’une clé, faites pivoter la clé.
Créer une clé API
- Accédez à l’onglet API Keys.
- Cliquez sur New key.
- Attribuez à la clé un nom explicite.
- Cliquez sur Create.
- Copiez immédiatement la clé et conservez-la en lieu sûr.
Renommer une clé API
Renommez une clé pour indiquer ce qui l’utilise : il sera ainsi plus facile, par la suite, d’identifier l’origine d’une clé que vous ne reconnaissez pas. Le renommage ne modifie pas le secret de la clé et n’interrompt aucun service qui l’utilise.- Trouvez la clé dans le tableau.
- Cliquez sur le menu d’actions à la fin de la ligne de la clé, puis sur Edit.
- Saisissez un nouveau nom, puis enregistrez.
Supprimer des clés API
Supprimez une clé lorsque vous n’en avez plus besoin, ou immédiatement si elle a pu être exposée. Pour supprimer une seule clé, trouvez-la dans le tableau, cliquez sur le menu d’actions à la fin de sa ligne, puis cliquez sur Supprimer et confirmez. Pour supprimer plusieurs clés à la fois :- Cochez la case en regard de chaque clé à supprimer.
- Cliquez sur Supprimer. Le bouton indique le nombre de clés sélectionnées.
- Confirmez la suppression.
Faire pivoter une clé API
Faites pivoter vos clés selon un calendrier conforme à votre politique de sécurité, et immédiatement si une clé a pu être exposée. Faites pivoter une clé plutôt que de la supprimer lorsque les charges de travail qui l’utilisent doivent continuer de s’exécuter. W&B ne propose pas d’action de rotation en une seule opération. Comme le secret complet d’une clé n’est affiché qu’à sa création, la rotation consiste à remplacer la clé :- Créez une nouvelle clé API. Donnez-lui un nom qui la distingue de la clé à remplacer.
- Mettez à jour tous les scripts, jobs et secrets stockés qui utilisent l’ancienne clé. Pour connaître les options de stockage, consultez Stocker et gérer les clés API en toute sécurité.
- Vérifiez que vos charges de travail s’authentifient avec la nouvelle clé.
- Supprimez l’ancienne clé.
Restreindre l’utilisation des clés API par les membres
Les administrateurs de l’organisation peuvent restreindre la création et l’utilisation des clés depuis les paramètres de l’organisation dans la W&B App. Ces restrictions déterminent quelles clés peuvent accéder aux ressources de votre organisation et qui peut en créer de nouvelles. Les sections suivantes décrivent les restrictions disponibles, qui varient selon le type de déploiement.Appliquer les clés API limitées à l’organisation
Disponible dans le Cloud mutualisé pour les organisations Enterprise. W&B active ce paramètre organisation par organisation. Si vous ne le voyez pas, contactez votre équipe de compte W&B. Lorsque ce paramètre est appliqué, seules les clés API d’organisation et les clés appartenant aux comptes de service de l’organisation peuvent accéder aux ressources de celle-ci. Une clé API personnelle qu’un membre utilise dans plusieurs organisations ne fonctionne plus pour cette organisation, ce qui empêche une clé divulguée ailleurs d’accéder à vos données. Pour appliquer les clés API limitées à l’organisation, procédez comme suit :- Connectez-vous en tant qu’administrateur de l’organisation.
- Ouvrez les paramètres de votre organisation, puis sélectionnez Authentication dans le menu de navigation de gauche.
- À côté de Enforce organization-scoped API keys, cliquez sur Enforce.
- Saisissez le nom de votre organisation pour confirmer, puis cliquez sur Enforce Organization-Scoped API Keys.
Désactiver la création de clés API
Disponible dans le Cloud dédié et en mode autogéré à partir de la version v0.84.0. Lorsque ce paramètre est activé, les utilisateurs et les comptes de service d’équipe ne peuvent plus créer de nouvelles clés API. Les comptes de service de l’organisation peuvent toujours en créer, et les clés existantes continuent de fonctionner : l’activation de ce paramètre n’interrompt donc pas les jobs en cours. Utilisez ce paramètre si votre organisation délivre les clés selon un processus contrôlé et que vous souhaitez empêcher les membres de créer leurs propres clés. Pour désactiver la création de clés API, procédez comme suit :- Connectez-vous en tant qu’administrateur de l’organisation.
- Ouvrez le tableau de bord de votre organisation, puis sélectionnez Privacy dans le menu de navigation de gauche.
- Dans la section Access Control, activez Disable API key creation.
GORILLA_DISABLE_TEAM_SERVICE_ACCOUNT_CREATION, qui empêche la création de nouveaux comptes de service à portée d’équipe sur le Cloud dédié et sur les déploiements autogérés en version v0.83.0 ou ultérieure.
Disponibilité
Les fonctionnalités des clés API varient selon le type de déploiement et, dans le Cloud mutualisé, selon l’abonnement. Le tableau suivant récapitule la disponibilité de chaque fonctionnalité.Stocker et gérer les clés API en toute sécurité
Les clés API donnent accès à votre compte W&B et doivent être protégées comme des mots de passe. Les sections suivantes présentent les méthodes de stockage recommandées, les pratiques à éviter, la manière de transmettre les clés à votre code, ainsi que les exigences de version du SDK pour les clés plus récentes.Méthodes de stockage recommandées
Utilisez l’une des méthodes suivantes pour stocker votre clé API en toute sécurité.- Gestionnaire de secrets : utilisez un système dédié à la gestion des secrets, tel que AWS Secrets Manager, HashiCorp Vault, Azure Key Vault ou Google Secret Manager.
- Gestionnaire de mots de passe : utilisez une application de gestion de mots de passe reconnue.
- Trousseaux du système d’exploitation : stockez les clés dans le trousseau macOS (Keychain), le Gestionnaire d’identifiants Windows ou le service de secrets Linux. Déconseillé en production.
À éviter
Évitez les pratiques suivantes, qui peuvent exposer votre clé API :- Ne commitez jamais de clés API dans des systèmes de gestion de versions tels que Git.
- Ne stockez pas de clés API dans des fichiers de configuration en texte brut.
- Ne passez pas de clés API en ligne de commande, car elles sont visibles dans la sortie de commandes du système d’exploitation comme
ps. - Évitez de partager des clés API par e-mail, par chat ou par tout autre canal non chiffré.
- N’intégrez pas de clés API en dur dans votre code source.
Variables d’environnement
Lorsque vous utilisez des clés API dans votre code, transmettez-les via des variables d’environnement :Compatibilité des versions du SDK
Si vous utilisez une clé API récente, vérifiez que votre version du SDK la prend en charge. Les clés API récentes sont plus longues que les anciennes. Si vous vous authentifiez avec une ancienne version du SDKwandb ou weave, une erreur liée à la longueur de la clé API peut survenir.
Solution : passez à une version plus récente du SDK :
-
SDK
wandbv0.22.3+ -
SDK
weavev0.52.17+
WANDB_API_KEY.