API-Schlüssel

API Schlüssel werden auf Organisationsebene mit rollenbasierten Zugriffssteuerungen (RBAC) verwaltet. Jeder Schlüssel kann einer Organisationsebene Rolle und optional pro-Anwendung-Rollen zugewiesen werden, was Ihnen eine feinmaschige Kontrolle über das, was jeder Schlüssel zugreifen kann.

Wo werden API Schlüssel verwaltet?

Navigieren Sie zu Einstellungen > Organisation > API-Schlüssel bei console.capgo.app/settings/organisation/api-schlüssel.

Die Seite zeigt zwei Abschnitte an:

• 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 erstelle ich einen neuen API-Schlüssel?

1. Klicken Sie auf den ”+” Schaltfläche oben in 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 Leserecht").
   • 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. Nur einmal nach der Erstellung angezeigt. Sie können ihn später nicht mehr abrufen.
   • Ablaufdatum festlegen (optional) — Wählen Sie einen Zeitpunkt, ab dem der Schlüssel nicht mehr funktioniert. Einige Organisationen erzwingen eine obligatorische Ablaufzeit über eine Richtlinie.

3. Wählen Sie ein Organisationsrolle — Dies definiert die Grundrechte des Schlüssels innerhalb der gesamten Organisation. Verfügbare Rollen (abhängig von Ihrem eigenen Rollenlevel):

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

4. Wenn der Schlüssel Organisationen über den öffentlichen API erstellen soll, aktivieren Sie Erstelle Organisationen zulassen.

   Dies fügt die globale org.create Erlaubnis hinzu. Sie ist verfügbar, wenn die Schlüssel eine Admin-Rolle für Organisationen hat. Wenn dieser Schlüssel eine neue Organisation erstellt, Capgo erteilt dem Schlüssel automatisch die Rolle Super Admin auf dieser neuen Organisation.

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

   • Klicken Sie ”+ App hinzufügen” um die App-Wähler zu öffnen.
   • Wählen Sie eine oder mehrere Apps aus, dann erteilen Sie jeder eine Rolle:
     • App-Leser — Nur-Lesezugriff auf die App.
     • App-Uploader — Neue Bundle hochladen können.
     • App-Entwickler — Die App-Konfiguration und -Deployments verwalten können.
     • App-Admin — Vollzugriff auf die App.

6. Klicken “Erstellen”.

7. Wenn Sie ‘Sicheren Schlüssel erstellen’ ausgewählt haben, wird ein Modalfenster mit dem Plain-Text-Schlüssel angezeigt. Kopieren Sie ihn sofort, da er nach Schließen des Modalfensters nicht wiederhergestellt werden kann. Einmaliger __CAPGO_KEEP_0__-Schlüssel-Sekret-Modal mit Kopier-Button

How managt man (bearbeiten) eine API-Schlüssel?

Klicken Sie auf das Schraubenzieher-Icon (Verwalten) auf jedem RBAC-Schlüssel in der Liste. Dies öffnet die Detailseite des Schlüssels, auf der Sie Folgendes tun können:

• Den Schlüssel namen ändern.
• Die Organisationsrolle aktualisieren.
• Das Erstellen von Organisationen zulassen wenn der Schlüssel eine Admin-Organisationsrolle hat.
• Hinzufügen, entfernen oder ändern Anwendungsrollen.

Klicken “Änderungen speichern” Wenn fertig.

Wie kann man einen API Schlüssel neu generieren?

Um die geheime Werte eines API Schlüssels neu zu generieren, klicken Sie auf das aktualisieren Icon (Neu generieren) auf jeder Schlüssel in der Liste.

Ein Bestätigungsdialog wird erscheinen. Nach Bestätigung:

• Sicherheit (gehashter) Schlüssel : Ein neuer plain-Text-Schlüssel wird generiert und einmal in einem Modalfenster angezeigt. Kopieren Sie ihn sofort.Sicherheit (plain) Schlüssel
• : Der Schlüsselwert wird serverseitig neu generiert. Jede Integration mit dem alten Schlüsselwert wird sofort aufhören zu funktionieren.__CAPGO_KEEP_0__ Schlüsselregenerierung-Bestätigung

Wie kann man einen __CAPGO_KEEP_0__-Schlüssel löschen?

How to delete an API key?

Icon für das Löschen Icon für das Löschen Mit (Löschen) auf jeder Taste in der Liste bestätigen Sie die Löschung im Dialog.

Die Taste wird sofort ungültig — jede Anfrage mit ihr wird fehlschlagen.

Veraltete Schlüssel

Wenn Sie Schlüssel in der Veralteten Schlüssel Sektion (Schlüssel ohne Rollenzuweisungen) sehen, verwenden diese das ältere Modus-basierte Berechtigungssystem (read, upload, write, all). Sie funktionieren zwar noch, nutzen aber keine RBAC-fein abgestuften Berechtigungen.

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

Wenn Sie veraltete Schlüssel direkt verwalten müssen, können Sie sie immer noch unter https://console.capgo.app/dashboard/apikeys. Diese Seite wird abgeschafft und wird in einer zukünftigen Aktualisierung entfernt.

Weitermachen von API Schlüsseln

Wenn Sie "__CAPGO_KEEP_0__ Schlüsseln" verwenden, um das Dashboard und __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit "__CAPGO_KEEP_0__ Übersicht" für die Implementierungsdetails in "API Übersicht", to plan dashboard and API operations, connect it with API Overview Weitermachen von API Schlüsseln für die Implementierungsdetails in Weitermachen von __CAPGO_KEEP_0__ Schlüsseln If you are using API Keys to plan dashboard and API operations, connect it with Geräte für die Implementierungsdetails in Geräte, und Pakete für die Implementierungsdetails in Pakete.