JetBrains-Konto-API
Mit der JetBrains-Konto-API können Sie die Lizenzen und Benutzerkonten Ihrer Organisation automatisch verwalten.
Sie können die API verwenden, um:
- Lizenzdetails abrufen
- Lizenzen zuweisen oder widerrufen
- Lizenzen zwischen Teams übertragen
- Benutzerkonten erstellen oder löschen
JetBrains-Konto-API-Referenz
Für die vollständige Liste der API-Methoden siehe die JetBrains-Konto-API-Referenz.
Die Kontoverwaltungsfunktionen sind nur für Organisationen mit einer verifizierten Domain verfügbar.
API-Zugriffsebenen
Ihre Rolle im Organisationsprofil bestimmt, was Sie in der JetBrains-Konto-Benutzeroberfläche tun können, welche Informationen Sie über die API abrufen können und ob Sie diese ändern dürfen.
| Rolle | Was Sie in der JetBrains-Konto-Benutzeroberfläche tun können | Worauf Sie über die API zugreifen können | API-Zugriffsebene |
|
Gesamtes Organisationsprofil |
Vollzugriff |
|
|
Ihr Team |
Vollzugriff |
|
|
Betrachter und primäre Kontakte |
Gesamtes Organisationsprofil |
Schreibgeschützt |
API aktivieren oder deaktivieren
| 🔒 Erforderliche Berechtigungen: Organisationsadmin. |
Um die API zu aktivieren:
- Melden Sie sich bei Ihrem JetBrains-Konto an.
- Klicken Sie im Menü links auf den Namen der Organisation.
- Im erscheinenden Menü wählen Sie Administration.
-
Im API-Bereich klicken Sie auf Enable API.
Dies gewährt API-Zugriff für alle Admins, Betrachter und primären Kontakte. Sie können persönliche API-Tokens generieren und, abhängig von ihrer Rolle, auf das Organisations- oder Teamprofil durch die API zugreifen.
API deaktivieren
Um die API zu deaktivieren, führen Sie die Schritte 1 und 3 in den obigen Anweisungen aus und klicken dann auf Disable API. Dadurch wird die API für alle in der Organisation deaktiviert.
Wenn Sie die API wieder aktivieren, bleiben jene Tokens gültig, es sei denn, sie wurden entfernt oder regeneriert. Wenn Sie die API später wieder aktivieren, arbeiten diese wieder. Siehe Token-Lebensdauer für Details.
API-Zugangstokens verwalten
Wenn Ihre Rolle im Organisationsprofil Ihnen API-Zugriff gewährt, können Sie ein persönliches Zugriffstoken generieren und es nach Bedarf regenerieren oder entfernen. Organisations- und Teamadmins können ebenfalls Tokens verwalten, die von anderen in ihrer Organisation oder ihrem Team generiert wurden.
Verwalten Sie Ihr persönliches API-Token
| 🔒 Erforderliche Berechtigungen: Organisationsadmin, Teamadmin oder primärer Abrechnungskontakt. |
Um die API zu nutzen, benötigen Sie ein persönliches Zugriffstoken. Sie können es erstellen, neu generieren oder entfernen, wann immer es nötig ist. Ihr Token ist mit Ihrem Konto verbunden, sodass alle damit gemachten API-Anfragen mit Ihnen in Verbindung stehen. Andere Mitglieder Ihrer Organisation mit API-Zugriff können ebenfalls ihre eigenen Tokens generieren.
Persönliches Token generieren
- Stellen Sie sicher, dass das JetBrains-Konto-API in Ihrer Organisation aktiviert ist.
- Melden Sie sich bei Ihrem JetBrains-Konto an.
- Wählen Sie links im Menü entsprechend Ihrer Rolle eine der folgenden Möglichkeiten:
- Wenn Sie Organisationsadmin, Betrachter oder primärer Kontakt sind, klicken Sie auf den Namen Ihrer Organisation:
- Wenn Sie ein Teamadmin sind, klicken Sie auf den Namen Ihres Teams:
- Wenn Sie Organisationsadmin, Betrachter oder primärer Kontakt sind, klicken Sie auf den Namen Ihrer Organisation:
- Im API-Abschnitt der Administrationsseite klicken Sie auf Generate Token.
-
Wenn der Dialog erscheint, sehen Sie Ihr Token. Aus Sicherheitsgründen wird es nur einmal angezeigt. Stellen Sie sicher, dass Sie ihn an einem sicheren Ort speichern, bevor Sie das Dialogfenster schließen.
Teilen Sie Ihr Token mit niemandem. Wenn es kompromittiert wird, generieren oder entfernen Sie es sofort.
Persönliches Token neu generieren
Möglicherweise müssen Sie Ihr persönliches Token neu generieren, wenn:
- Sie den Zugriff auf Ihr aktuelles verloren haben.
- Ihr Token kompromittiert wurde.
Um ein neues Token zu generieren:
- Führen Sie die Schritte 1–3 in den Anweisungen aus, um ein persönliches Token zu generieren.
- Im API-Abschnitt der Administrationsseite klicken Sie auf Re-Generate Token.
- Wenn ein Bestätigungsdialog angezeigt wird, klicken Sie erneut auf Re-Generate Token.
- Im nächsten Popup-Dialog sehen Sie Ihr neues Token. Aus Sicherheitsgründen wird es nur einmal angezeigt. Stellen Sie sicher, dass Sie ihn an einem sicheren Ort speichern, bevor Sie das Dialogfenster schließen.
Wenn Sie Ihr Token neu generieren, wird das alte sofort ungültig. Stellen Sie sicher, dass Ihr Token in allen Anwendungen, die die API verwenden, aktualisiert wird.
Persönliches Zugriffstoken entfernen
Wenn Sie keinen Zugriff auf die API mehr benötigen, folgen Sie diesen Schritten, um Ihr Token zu entfernen:
- Führen Sie die Schritte 1–3 in den Anweisungen aus, um Ihr Token zu generieren.
- Im API-Abschnitt der Administrationsseite klicken Sie auf Remove Token.
- Wenn ein Bestätigungsdialog angezeigt wird, klicken Sie erneut auf Remove Token.
API-Tokens verwalten, die von anderen generiert wurden
Als Organisations- oder Teamadmin können Sie API-Tokens, die von anderen Mitgliedern Ihrer Organisation oder Ihres Teams generiert wurden, anzeigen und widerrufen.
Organisationweite API-Tokens anzeigen und widerrufen
| 🔒 Erforderliche Berechtigungen: Organisationsadmin. |
- Folgen Sie den Schritten 1–3 in den obigen Anweisungen, um die Org-Administrationsseite zu öffnen.
- Auf der Administrationsseite scrollen Sie nach unten zu Users with access to company licenses.
- In der Spalte API-Token sehen Sie alle Personen in Ihrer Organisation, die ein Token generiert haben.
- Um ein Token zu widerrufen, suchen Sie den Benutzer oder die Benutzerin in der Tabelle und klicken Sie auf Revoke.
Teamspezifische API-Tokens anzeigen und widerrufen
| 🔒 Erforderliche Berechtigungen: Organisationsadmin oder Teamadmin. |
- Führen Sie die Schritte 1–3 gemäß den Anweisungen zur Token-Generierung aus, um die Teamadmin-Seite zu öffnen.
- Auf der Administrationsseite scrollen Sie nach unten zum Abschnitt Team Administration.
- In der Spalte API-Token sehen Sie alle Personen in Ihrem Team, die ein Token generiert haben.
- Um ein Token zu widerrufen, suchen Sie den Benutzer oder die Benutzerin in der Tabelle und klicken Sie auf Revoke.
Token-Lebensdauer
Einmal ausgestellt, haben JetBrains-Konto-API-Tokens eine unbegrenzte Lebensdauer.
Benutzer*innen erhalten ein Token, selbst wenn sie mehrere Rollen haben. Sofern sie es nicht regenerieren oder entfernen, bleibt das Token aktiv, solange sie mindestens eine Rolle behalten. Wenn sie alle Rollen verlieren, wird das Token automatisch widerrufen.
Wenn Sie die API deaktivieren und später wieder aktivieren, bleiben zuvor generierte Tokens gültig, es sei denn, sie wurden entfernt oder regeneriert.
Wenn Ihr persönliches Token kompromittiert wird, regenerieren oder entfernen Sie es sofort. Wenn das Token einer anderen Person kompromittiert ist, widerrufen Sie es.
API-Methoden verwenden
Siehe die JetBrains-Konto-API-Referenz für die vollständige Liste der verfügbaren Methoden. Beachten Sie, dass die Kontoverwaltungsfunktionen nur für Organisationen mit einer verifizierten Domain verfügbar sind.
Um die API-Methoden zu verwenden, benötigen Sie zwei Parameter:
1. Ihre Kunden-ID für X-Customer-Code
Ihre JetBrains-Kunden-ID ist ein eindeutiges Identifizierungsmerkmal, das mit den Bestellungen und Lizenzen Ihres Unternehmens verknüpft ist. Sie können es in Ihrem JetBrains-Konto finden.
Verwenden Sie diesen Wert für den X-Customer-Code Parameter in Ihrer Anfrage.
2. Ihr Zugriffstoken für X-Api-Key
Folgen Sie den obigen Schritten, um Ihr persönliches Token zu generieren. Verwenden Sie es für den X-Api-Key Parameter.