Zum Hauptinhalt springen
Version: 1.89.x (Q2 26)

API-Schlüssel

Dieser Leitfaden erklärt, wie API-Schlüssel in Codesphere erstellt und verwaltet werden.

API-Schlüssel werden innerhalb der Benutzereinstellungen verwaltet.

  1. Klicke auf das Profilbild in der oberen rechten Ecke.
  2. Wähle User Settings.
  3. Navigiere zum Tab API Keys in der linken Seitenleiste.

Einen neuen API-Schlüssel erstellen​

API-Schlüssel ermöglichen es externen Anwendungen, im eigenen Namen mit Codesphere zu interagieren.

  1. Klicke im Bereich API Keys auf die Schaltfläche Add New Key.
  2. Gib dem Schlüssel einen Namen (z. B. „GitHub Actions“ oder „Local Development“), um dich später an seinen Zweck erinnern zu können.
  3. Klicke auf Create.
  4. Kopiere den Schlüssel sofort. Aus Sicherheitsgründen wird der Schlüssel nur einmal angezeigt. Geht er verloren, muss er neu generiert werden.

Wichtiger Hinweis zu Zugriffsrechten
Derzeit besitzt ein API-Schlüssel, der für ein Konto ausgestellt wird, dieselben Zugriffsrechte und Berechtigungen wie das jeweilige Benutzerkonto selbst. Die Unterstützung für fein abgestufte Zugriffstoken (Scopes) ist für die Zukunft geplant und wird zu einem späteren Zeitpunkt hinzugefügt.

Tipp-Symbol

Hast du einen Feature-Wunsch? Hilf uns, die Zukunft von Codesphere mitzugestalten. Neue Funktionen können vorgeschlagen oder auf der Community-Roadmap unter feedback.codesphere.com bewertet werden.

Einen API-Schlüssel neu generieren​

  1. Suche den entsprechenden Schlüssel in der Liste API Keys.
  2. Klicke auf das Symbol Regenerate (kreisförmiger Pfeil) neben dem Namen des Schlüssels.
  3. Bestätige die Aktion im Popup-Fenster.
  4. Anwendungen aktualisieren: Der alte Schlüssel wird sofort ungültig und muss im Code oder in den Umgebungsvariablen durch den neuen Schlüssel ersetzt werden.

Häufig gestellte Fragen​

  1. Wie viele Schlüssel können erstellt werden?
    Es können beliebig viele Schlüssel generiert werden.

  2. Was passiert, wenn ein Schlüssel gelöscht wird?
    Jede Anwendung, die diesen Schlüssel verwendet, erhält beim nächsten Verbindungsversuch sofort einen 401-Unauthorized-Fehler.

  3. Kann ein Schlüssel auf „Nur Lesen“ beschränkt werden?
    Noch nicht. Derzeit erben alle Schlüssel die vollen Berechtigungen des jeweiligen Kontos.