API-Schlüssel

API Schlüssel werden auf Organisationsebene mit rollenbasierten Zugriffssteuerungen (RBAC) verwaltet. Jeder Schlüssel kann einer Organisationsebene eine Rolle zugewiesen und optional pro Anwendung eine Rolle, was Ihnen eine feinmaschige Kontrolle über den Zugriff auf jeden Schlüssel ermöglicht.

Wo werden API Schlüssel verwaltet?

Zu Einstellungen > Organisation > API-Schlüssel bei console.capgo.app/settings/organization/api-schlüssel.

Die Seite zeigt zwei Abschnitte:

• RBAC-Schlüssel — Schlüssel mit zugewiesenen Rollen (empfohlen). Diese Schlüssel verwenden das neue rollenbasierte Berechtigungssystem.
• Legacy-Schlüssel — Ältere Schlüssel, die das einfache Modus-basierte System (read, upload, write, all) ohne Rollenzuweisungen verwenden.

Wie erstellt man eine neue API-Schlüssel?

1. Klicken Sie auf den ”+” Schaltfläche oben auf der Tabelle der RBAC-Schlüssel.

2. Füllen Sie die Schlüsselinformationen:

   • Name (Pflichtfeld) — Eine beschreibende Bezeichnung für den Schlüssel (z.B. “CI/CD Deploy”, “Monitoring Read-Only”).
   • Sicheren Schlüssel erstellen (optional) — Wenn aktiviert, wird der Schlüssel serverseitig gehasht. Der plain-text-Schlüssel wird nur einmal nach der Erstellung angezeigt. Sie können ihn später nicht mehr abrufen. nur einmal nach der Erstellung
   • Ablaufdatum setzen (optional) — Wählen Sie ein Datum, nach dem der Schlüssel nicht mehr funktioniert. Einige Organisationen erzwingen eine obligatorische Ablaufzeit durch Richtlinie.

3. Wählen Sie ein Organisationsrolle — Dies definiert die Grundrechte des Schlüssels für die gesamte Organisation. Verfügbare Rollen (abhängig von Ihrem eigenen Rolle-Niveau):

   • Keine — Keine Organisationsebene-Zugriff; der Schlüssel hat nur Zugriff auf individuell zugewiesene Apps.
   • Mitglied — Grundlegende Leserechte für die Organisation.
   • Administrator — Vollständiger administrativer Zugriff auf die Organisation (erbt Zugriff auf alle Apps).

4. Wenn die ausgewählte Org-Rolle nicht Admin ist, können Sie pro-Anwendung-Zugriff:

   • Klicken Sie auf um das App-Picker zu öffnen.
   • Wählen Sie eine oder mehrere Apps aus, dann zuweisen Sie eine Rolle zu jeder:
     • App-Leser — Nur-Lese-Zugriff auf die App.
     • App-Uploader — Neuere Pakete hochladen können.
     • App-Entwickler — Die App-Konfiguration und -Deployments verwalten können.
     • App Admin — Vollzugriff auf die App.

5. Klicken Sie .

6. Wenn Sie 'Sicheres Schlüssel erstellen' ausgewählt haben, wird ein Modalfenster mit dem Plain-Text-Schlüssel angezeigt. Kopieren Sie ihn sofort — er kann nicht nach dem Schließen des Modalfensters wiederhergestellt werden.

Wie man einen API-Schlüssel (bearbeiten) verwalten kann?

Klicken Sie Schraubenzieher-Symbol (Verwalten) auf jeder RBAC-Schlüssel in der Liste. Dies öffnet die Detailseite des Schlüssels, auf der Sie können:

• Den Schlüssel name.
• Den Organisationsrolle.
• Hinzufügen, entfernen oder ändern Anwendungsrollen.

Klicken Sie Speichern Sie die Änderungen

How kann man einen API-Schlüssel neu generieren?

Um den geheimen Wert eines API-Schlüssels neu zu generieren, klicken Sie auf das aktualisierungs-Symbol (Neu generieren) auf jeder Schlüssel in der Liste.

Eine Bestätigungsanzeige erscheint. Nach Bestätigung:

• Für sichere (gehashte) Schlüssel: Ein neuer Textschlüssel wird generiert und wird einmal in einem Modalfenster angezeigt. Kopieren Sie ihn sofort.
• Für plaine Schlüssel: Der Schlüsselwert wird serverseitig neu generiert.

Jede Integration mit dem alten Schlüssel-Wert funktioniert sofort nicht mehr.

Wie lösche ich den API-Schlüssel?

Klicken Sie auf den Müll-Icon (Löschen) auf jedem Schlüssel in der Liste. Bestätigen Sie die Löschung im Dialog.

Der Schlüssel wird sofort widerrufen — jede Anfrage mit ihm wird fehlschlagen.

Veraltete Schlüssel

Wenn Sie Schlüssel in der sehen Legacy Schlüssel Abschnitt (Schlüssel ohne Rollenzuweisungen), diese verwenden das ältere Modus-basierte Berechtigungssystem (read, upload, write, all). Sie funktionieren noch, nutzen aber nicht die Vorteile des RBAC fein granulierten Berechtigungssystems.

Legacy-Schlüssel können regeneriert und gelöscht werden, können aber nicht bearbeitet werden, um RBAC-Rollen hinzuzufügen. Wir empfehlen, neue RBAC-Schlüssel zu erstellen und Legacy-Schlüssel zu löschen, wenn möglich.

Wenn Sie Legacy-Schlüssel direkt verwalten müssen, können Sie sie immer noch auf der Seite console.capgo.app/dashboard/apikeyszurückgreifen. Diese Seite ist veraltet und wird in einer zukünftigen Aktualisierung entfernt.