API-Schlüssel

API-Schlüssel werden auf Organisationsebene mit rollenbasiertem Zugriffscontrol (RBAC) verwaltet. Jeder Schlüssel kann einer Organisationsebene Rolle und optional pro-App-Rollen zugewiesen werden, wodurch Sie eine feinmaschige Kontrolle über das, was jeder Schlüssel zugreifen kann, erhalten.

Wo werden API-Schlüssel verwaltet?

Navigieren Sie zu Einstellungen > Organisation > API-Schlüssel in console.capgo.app/settings/organization/api-keys.

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 ”+” Knopf oben auf der RBAC-Schlüssel-Tabelle.

2. Füllen Sie das Schlüsselinformationen:

   • Name (erforderlich) — Eine beschreibende Bezeichnung für die Schlüssel (z.B. „CI/CD Deploy“, „Monitoring Read-Only“).
   • Sicheren Schlüssel erstellen (optional) — Wenn ausgewählt, wird der Schlüssel serverseitig gehasht. Der plain-text-Schlüssel wird nur einmal angezeigt. Nur einmal nach der Erstellung. Sie werden ihn später nicht mehr abrufen können.
   • Setzen Sie eine Ablaufdatum (optional) — Wählen Sie ein Datum, nach 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 Schlüssel-Basisberechtigungen über die gesamte Organisation. Verfügbare Rollen (abhängig von Ihrem eigenen Rolle-Niveau):

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

4. Wenn der Schlüssel über die öffentliche API Organisationen erstellen soll, aktivieren Sie Organisationen erstellen.

   Dies fügt den globalen org.create Berechtigung hinzu. Sie ist verfügbar, wenn der Schlüssel eine Administratorrolle in der Organisation hat. Wenn dieser Schlüssel eine neue Organisation erstellt, Capgo erteilt dem Schlüssel automatisch die Rolle des Super Administrators auf dieser neuen Organisation.

5. Wenn die ausgewählte Org-Rolle nicht Administrator ist, können Sie Anwendungs-zu-Anwendungs-Zugriff hinzufügen:

   • Klicken "+ App hinzufügen" um den App-Chooser zu öffnen.
   • Wählen Sie eine oder mehrere Apps aus und zuweisen Sie jeder eine Rolle:
     • App-Leser — Nur-Lese-Zugriff auf die App.
     • App-Uploader — Neuere Pakete hochladen können.
     • App-Entwickler — Die App-Konfiguration und -Dienste verwalten können.
     • App-Admin — Vollzugriff auf die App.

6. Klicken “Erstellen”.

7. Wenn Sie ‘Sicheres Schlüssel erstellen’ ausgewählt haben, wird ein Modalfenster angezeigt, das den Klartextschlüssel anzeigt. 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 auf den Zahnradsymbol ‘(Bearbeiten)’ auf jedem RBAC-Schlüssel in der Liste. Dies öffnet die Detailseite des Schlüssels, auf der Sie Folgendes tun können:

• Ändern Sie die Schlüssel Name.
• Aktualisieren Sie die Organisationsrolle.
• Aktivieren oder deaktivieren Erstellen Sie Organisationen zulassen wenn der Schlüssel eine Admin-Org-Rolle hat.
• Hinzufügen, entfernen oder ändern Anwendungsrollen pro App.

Klicken Sie “Änderungen speichern” wenn fertig.

Wie regeneriert man einen API Schlüssel?

Um die geheime Werte eines API Schlüssels zu regenerieren, klicken Sie auf das aktualisieren-Symbol (Regenerieren) auf jedem Schlüssel in der Liste.

Ein Bestätigungsdialog erscheint. Nach Bestätigung:

• Für sichere (gehashte) Schlüssel: Ein neuer plain-Text-Schlüssel wird generiert und einmal in einem Modalfenster angezeigt. Kopieren Sie ihn sofort.
• Für plain SchlüsselDie Schlüsselwerte werden serverseitig neu generiert.

Jede Integration mit dem alten Schlüsselwert wird sofort aufhören zu funktionieren.

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

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 ungültig – jede Anfrage mit ihm wird fehlschlagen.

Veraltete Schlüssel

If Sie Schlüssel im Bereich "Legacy Keys" (Schlüssel ohne Rollenzuweisungen) sehen, verwenden diese das ältere Modus-basierte Berechtigungssystem ( ). Sie funktionieren noch, nutzen aber nicht die Vorteile des RBAC-fine-granularen Zugriffs. Legacy-Schlüssel können erneuert 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 Legacy-Schlüssel zu löschen, wenn möglich.read, upload, write, allWenn Sie Legacy-Schlüssel direkt verwalten müssen, können Sie sie immer noch auf der Seite

console.__CAPGO_KEEP_0__.app/dashboard/apikeys

zugreifen. Diese Seite ist veraltet und wird in einer zukünftigen Aktualisierung entfernt. Weiter von capgo SchlüsselnAbschnitt mit dem Titel “Weiter von __CAPGO_KEEP_0__ Schlüsseln”

Wenn Sie API Schlüssel verwenden

Legacy Keys API Keys Um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit API-Übersicht Für die Implementierungsdetails in der API-Übersicht Einführung Für die Implementierungsdetails in der Einführung API-Schlüssel Für die Implementierungsdetails in den API-Schlüsseln Geräte Für die Implementierungsdetails in Geräten und Bundles Für die Implementierungsdetails in Bundles.