API du compte JetBrains
L’API JetBrains Account vous permet de gérer les licences et récupérer les données d’utilisation des licences de votre compte JetBrains.
Vous pouvez utiliser l’API pour :
- Obtenir les détails des licences
- Attribuer ou révoquer des licences
- Transférer des licences entre équipes
- Créer ou supprimer des comptes utilisateur
Référence de l’API du compte JetBrains
Pour obtenir la liste complète des méthodes API, consultez la documentation de référence sur l’API du compte JetBrains.
Notez que les fonctionnalités de gestion de compte ne sont disponibles que pour les organisations disposant d’un domaine vérifié.
Niveaux d’accès à l’API
Votre rôle dans le profil de l’organisation détermine ce que vous pouvez faire dans l’interface utilisateur de votre compte JetBrains, les informations auxquelles vous pouvez accéder via l’API et si vous êtes autorisé à les modifier.
| Rôle | Ce que vous pouvez faire dans l’interface utilisateur de votre compte JetBrains | Ce à quoi vous pouvez accéder via l’API | Niveau d’accès à l’API |
|
Profil de l’ensemble de l’organisation |
Accès complet |
|
|
Votre équipe |
Accès complet |
|
|
Observateurs et référents |
Profil de l’ensemble de l’organisation |
Lecture seule |
Activer ou désactiver l’API
| 🔒 Autorisations requises : administrateur de l'organisation. |
Pour activer l’API :
- Connectez-vous à votre compte JetBrains.
- Dans le menu de gauche, cliquez sur le nom de votre organisation.
- Dans le menu qui s’affiche, sélectionnez Administration.
-
Dans la section API, cliquez sur Enable API.
Cela donne un accès API à tous les administrateurs, observateurs et référents. Ils pourront générer des jetons d’API personnels et, en fonction de leur rôle, accéder au profil de l’organisation ou de l’équipe via l’API.
Désactiver l’API
Pour désactiver l’API, suivez les étapes 1 à 3 des instructions ci-dessus, puis cliquez sur Disable API. Cela désactivera l’API pour tous les membres de l’organisation.
La désactivation de l’API bloque l’accès au profil d’organisation via les méthodes API, mais elle n’invalide pas les jetons déjà générés. Si vous réactivez l’API ultérieurement, ces jetons fonctionneront toujours. Pour en savoir plus, consultez la section Durée de vie du jeton.
Gérer les jetons d’accès à l’API
Si votre rôle dans le profil de l’organisation vous donne accès à l’API, vous pouvez générer un jeton d’accès personnel et le regénérer ou le supprimer si nécessaire. Les administrateurs d’organisation et d’équipe peuvent également gérer les jetons générés par d’autres membres de leur organisation ou de leur équipe.
Gérer votre jeton d’API personnel
| ὑ Autorisations requises : administrateur de l’organisation, administrateur de l’équipe ou référent de facturation. |
Pour utiliser l’API, vous aurez besoin d’un jeton d’accès personnel. Vous pouvez le générer, le regénérer ou le supprimer à tout moment. Votre jeton est lié à votre compte, de sorte que toutes les requêtes API effectuées avec celui-ci vous seront associées. D’autres membres de votre organisation disposant d’un accès à l’API peuvent également générer leurs propres jetons.
Générer un jeton personnel
- Assurez-vous que l’API du compte JetBrains est activée dans votre organisation.
- Connectez-vous à votre compte JetBrains.
- Dans le menu de gauche, sélectionnez l’une des options suivantes, en fonction de votre rôle :
- Si vous êtes administrateur de l’organisation, observateur ou référent, cliquez sur le nom de votre organisation :
- Si vous êtes administrateur d’équipe, cliquez sur le nom de votre équipe :
- Si vous êtes administrateur de l’organisation, observateur ou référent, cliquez sur le nom de votre organisation :
- Dans la section API de la page d’administration, cliquez sur Generate Token.
-
Lorsque la boîte de dialogue s’affichera, vous verrez votre jeton. Pour des raisons de sécurité, nous ne l’affichons qu’une seule fois, alors assurez-vous de l’enregistrer dans un endroit sûr avant de fermer la boîte de dialogue.
Ne partagez votre jeton avec personne. S’il est compromis, regénérez-le ou supprimez-le immédiatement.
Générer à nouveau un jeton personnel
Vous pouvez avoir besoin de regénérer votre jeton personnel si :
- Vous avez perdu l’accès à votre jeton actuel.
- Votre jeton a été compromis.
Pour générer un nouveau jeton :
- Suivez les étapes 1 à 3 des instructions pour générer un jeton personnel.
- Dans la section API de la page d’administration, cliquez sur Re-Generate Token.
- Lorsqu’une boîte de dialogue de confirmation s’affiche, cliquez à nouveau sur Re-Generate Token.
- Votre nouveau jeton s’affichera dans la boîte de dialogue contextuelle suivante. Pour des raisons de sécurité, nous ne l’affichons qu’une seule fois, alors assurez-vous de l’enregistrer dans un endroit sûr avant de fermer la boîte de dialogue.
Si vous générez à nouveau votre jeton, l’ancien perd immédiatement sa validité. Assurez-vous d’actualiser votre jeton dans toutes les applications utilisant l’API.
Supprimer un jeton d’accès personnel
Si vous n’avez plus besoin d’accéder à l’API, procédez comme suit pour supprimer votre jeton :
- Suivez les étapes 1 à 3 des instructions pour générer votre jeton.
- Dans la section API de la page d’administration, cliquez sur Remove Token.
- Lorsqu’une boîte de dialogue de confirmation s’affiche, cliquez à nouveau sur Remove Token.
Gérer les jetons d’API générés par d’autres utilisateurs
En tant qu’administrateur d’organisation ou d’équipe, vous pouvez consulter et révoquer les jetons d’API générés par d’autres membres de votre organisation ou de votre équipe.
Afficher et révoquer des jetons API à l’échelle de l’organisation
| 🔒 Autorisations requises : administrateur de l'organisation. |
- Suivez les étapes 1 à 3 des instructions ci-dessus pour ouvrir la page d’administration de l’organisation.
- Sur la page d’administration, faites défiler jusqu’à Users with access to company licenses.
- Dans la colonne API token, vous pouvez voir tous les membres de votre organisation qui ont généré un jeton.
- Pour révoquer un jeton, recherchez l’utilisateur dans le tableau et cliquez sur Revoke.
Afficher et révoquer les jetons d’API spécifiques à l’équipe
| ὑ Autorisations requises : administrateur de l’organisation ou administrateur de l’équipe. |
- Suivez les étapes 1 à 3 des instructions pour générer votre jeton afin d’ouvrir la page d’administration de l’équipe.
- Sur la page d’Administration, faites défiler jusqu’à la section Team Administration.
- Dans la colonne API token, vous pouvez voir tous les membres de votre équipe qui ont généré un jeton.
- Pour révoquer un jeton, recherchez l’utilisateur dans le tableau et cliquez sur Revoke.
Durée de vie du jeton
Une fois émis, les jetons API du compte JetBrains ont une durée de vie indéfinie.
Chaque utilisateur reçoit un seul jeton, même s’il a plusieurs rôles. À moins qu’ils ne le regénèrent ou ne le suppriment, le jeton reste actif tant qu’ils conservent au moins un rôle. S’ils perdent tous leurs rôles, leur jeton est automatiquement révoqué.
Si vous désactivez l’API et que vous l’activez à nouveau ultérieurement, tous les jetons précédemment générés resteront valides, sauf si vous les supprimez ou les regénérez.
Si votre jeton personnel est compromis, regénérez-le ou supprimez-le immédiatement. Si le jeton de quelqu’un d’autre est compromis, révoquez-le.
Utiliser les méthodes d’API
Consultez la documentation de référence sur l’API du compte JetBrains pour consulter la liste complète des méthodes disponibles. Notez que les fonctionnalités de gestion de compte ne sont disponibles que pour les organisations disposant d’un domaine vérifié.
Pour utiliser les méthodes API, vous aurez besoin de deux paramètres :
1. Votre identifiant client pour X-Customer-Code
Votre identifiant client JetBrains est un identifiant unique associé aux commandes et licences de votre organisation. Vous le trouverez dans votre compte JetBrains.
Utilisez cette valeur pour le paramètre X-Customer-Code dans votre requête.
2. Votre jeton d’accès pour X-Api-Key
Suivez les étapes ci-dessus pour générer votre jeton personnel. Utilisez-le pour le paramètre X-Api-Key.