API Schlüssel

API-Schlüssel verwenden die Rollebasierte Zugriffssteuerung (RBAC). Ein Schlüssel kann eine Organisationseinheit-weite Rolle, Anwendungsbereichs-Bindungen oder beide haben. Jede Anwendungsbereichs-Bindung bleibt mit der zugehörigen Organisation verbunden. Um die geringste Privilegien zu gewähren, beschränken Sie einen Schlüssel auf ausgewählte Anwendungen anstatt eine Organisationseinheit-weite Rolle zuzuweisen.

Wo werden API-Schlüssel verwaltet?

Navigieren Sie zu Einstellungen > Organisation > API-Schlüssel auf 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 Rollebasierte Berechtigungssystem.
• Legacy Keys — Ältere Schlüssel, die das einfache Modus-basierte System (read, upload, write, all) ohne Rollenzuweisungen verwenden.

Wie erstellt man einen neuen API-Schlüssel?

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

2. Legen Sie die Schlüsselinformationen:

   • Name (Pflichtfeld) — Eine beschreibende Bezeichnung für den Schlüssel (z. B. “CI/CD Deploy” oder “Monitoring Read-Only”).
   • Schlüssel sicher erstellen (optional) — Wenn aktiviert, wird der Schlüssel serverseitig gehasht. Der plaintext-Schlüssel wird nur einmal nach der Erstellung angezeigt und kann später nicht mehr abgerufen werden. nur einmal nach der Erstellung und kann später nicht mehr abgerufen werden.
   • Schlüsselablaufdatum setzen (optional) — Wählen Sie eine Uhrzeit, nach der der Schlüssel nicht mehr funktioniert. Einige Organisationen erzwingen eine obligatorische Ablaufzeit durch Richtlinie.

3. Wählen Sie den Schlüsselscope:

   • Organisationsweite Zugriffsberechtigung — Wählen Sie eine Organisationsrolle um die Grundrechte innerhalb der Organisation festzulegen. Die verfügbaren Rollen hängen von Ihrem eigenen Rollenlevel ab:
     • Keine — Keine Organisationsebene Zugriff.
     • Mitglied — Grundlegende Leserecht auf die Organisation.
     • Administrator — Vollständiger Administratorzugriff auf die Organisation und alle ihre Apps.
   • Apps-only-Zugriff — Aktivieren Beschränken Sie diese Schlüssel auf ausgewählte Apps. Jedes App-Binding bleibt mit derjenigen App verbunden, die dieser App gehört; Diese Modus umfasst nur eine Organisationsebene RBAC-Rolle.

4. Wenn der Schlüssel Organisationen über den öffentlichen API erstellen muss, aktivieren Sie Erstellen von Organisationen zulassen.

   Dies fügt die globale org.create Berechtigung hinzu. Der Schlüssel benötigt auch eine organisationsspezifische org_admin oder org_super_admin Zulassung. In der Benutzeroberfläche wird die Auswahl von Admin die Erstellung der org_admin Zulassung herbeiführt. Wenn dieser Schlüssel eine neue Organisation erstellt, wird Capgo automatisch als Super Admin auf dieser neuen Organisation zugewiesen.

5. Um Anwendungen Zugriff zu gewähren:

   • Wenn Diese Schlüssel auf ausgewählte Apps beschränken ist aktiviert, wählen Sie eine Organisation unter Organisationen aus, um Apps zu filtern um ihre Apps zu enthüllen. Die ausgewählten App-Bindungen bleiben mit ihren eigenen Organisationen verbunden; diese Filterung gewährt keine Organisationseinblick.
   • Klicken ”+ Add App”Add App“
     • , 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
     • — Neuere Pakete hochladen, Geräte verwalten, native Builds auslösen und Kanal-Einstellungen aktualisieren können. App-Admin
     • App-Vorschau — Vorschau des CI/CD-Lebenszyklus: Laden Sie ein Bundle hoch und erstellen Sie einen Vorschaukanal. Der Kanal erhält automatische, kanalbezogene Rechte für den Lebenszyklus nur für diese Schlüssel.

6. Klicken Sie “Erstellen”.

7. Wenn Sie überprüft haben Sicheren Schlüssel erstellen, ein Modalfenster zeigt den Klartextschlüssel an. Kopieren Sie ihn sofort — er kann nicht nach dem Schließen des Modalfensters wiederhergestellt werden.

Verwenden Sie einen App-Vorschau-Schlüssel für Vorschau-Workflows

Verwenden App-Vorschau für CI, die eine temporäre, nicht öffentliche Vorschaukanal erstellt, ein Paket hochlädt und promotet und schließlich sowohl den Kanal als auch das Paket entfernt. Es hat keinen Zugriff auf das Lebenszyklus eines bestehenden Standard- oder Hauptkanals.

1. Erstellen Sie einen RBAC-Schlüssel und aktivieren Sie Beschränken Sie diesen Schlüssel auf ausgewählte Apps.
2. Unter Organisationen filtern Sie Apps, wählen Sie die Organisation aus, um ihre Apps zu enthüllen; jede ausgewählte App bleibt mit ihrer eigenen Organisation verbunden.
3. Fügen Sie nur die App oder Apps hinzu, die für Vorschau-Deployments verwendet werden.
4. Wählen Sie App-Vorschau für jede ausgewählte App.
5. Ein sicheres Schlüssel erstellen, eine Ablaufzeit setzen, wenn nötig, und ihn in Ihrem CI-Secret-Manager speichern.

Dieser ausgewählten-Anwendungen-Modus lässt eine Organisationseinheit-Rolle aus; es nicht entfernt die Organisationseinheits-Zuordnung. Jeder app_preview Bindung bleibt auf die ausgewählte Anwendung und die Organisation, die diese Anwendung besitzt, beschränkt.

Zugriffsrechte und Grenzen	auf der ausgewählten Anwendung
app_preview , und	app.read, app.read_bundles, app.upload_bundleAutomatische app.create_channel.
context:Seite/ Bereich: Capgo-Lösungen-Marketingseite. Rolle: Kurze Benutzeroberflächenschaltfläche oder Navigationselement. Gesehen in: Seite Lösungen/pr-vorschau.astro. Nachrichtenschlüssel `solutions_pr_step1_time` (Lösungen Pr Schritt1 Zeit). channel_preview Bindung	Wenn dieser Schlüssel einen Kanal erstellt, Capgo gibt dem Schlüssel automatisch channel.read, channel.promote_bundleund channel.delete für diesen Kanal nur.

app_preview behält app.read, sodass der Schlüssel die Kanalmetadaten der ausgewählten App auflisten kann. Die automatische Kindbindung ist ein Verwaltung Grenze: sie gewährt keine Lebenszyklusmutationen für Kanäle, die der Schlüssel nicht erstellt hat.

Capgo registriert auch, welcher App-Vorschau-Schlüssel ein Bundle hochgeladen hat. Der Schlüssel kann nur sein eigenes Bundle auf jedem Vorschaukanal erstellen und kann diese Paarung gemeinsam löschen. Er erhält keine Kanalbindung für einen bestehenden Standard- oder Hauptkanal, einen von einem anderen Vorschau-Schlüssel erstellten Kanal oder ein anderes Schlüssels Bundle.

Führen Sie für einen typischen CI-Auftrag einen eindeutigen Kanalnamen pro Pull-Request aus:

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

Führen Sie für einen neuen Kanal aus: bundle upload --channel erstellt den Kanal, lädt das Bundle hoch und bewirbt es in einem einzigen Workflow. Die letzte Anweisung verwendet eine enge atomische Reinigungsroute: Sie gelingt nur, wenn der Schlüssel den Vorschaukanal und dessen verbundenes, ungeteiltes Bundle besitzt. App-Vorschau hat noch keine allgemeine bundle.deleteso kann es einen beliebigen Bundle nicht löschen.

Vorsicht

Verwende einen neuen nicht öffentlichen pr-<number> Kanal. Übertrage keine --default, --self-assignRolle, oder --delete-linked-bundle-on-upload Optionen, zu diesem Workflow. Ein App-Vorschau Schlüssel kann nicht eine bestehende Standard/Hauptkanal, einen anderen Vorschau-Schlüssels Kanal, oder einen anderen Schlüssels Bundle promoten, löschen, oder ändern. Die Rücknahme oder Ablauf des App-Bindings entfernt auch den Schlüssels effektiven Lebenszyklus-Zugriff.

Siehe das Zugriffssteuerungsreferenz Für die volle Grenze.

Wie kann man einen API-Schlüssel bearbeiten?

Klicken Sie auf das Schraubenzieher-Symbol (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 benennen.
• Den Organisationsberechtigungsstatus.
• aktivieren oder deaktivieren Ermöglichen Sie die Erstellung von Organisationen Wenn die Taste eine Admin-Rolle in der Organisation hat.
• Hinzufügen, entfernen oder ändern Sie Rollen pro Anwendung.

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 Wiederholen-Symbol Wiederholen Sie auf jeder Schlüssel in der Liste.

Eine Bestätigungsanzeige erscheint. Nach Bestätigung:

• Für sichere (gehashpte) Schlüssel: Ein neuer Textschlüssel wird generiert und 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üsselwert funktioniert sofort nicht mehr.

Wie löscht man einen API-Schlüssel?

Klicken Sie auf das müllsymbol (Löschen) in der Liste eines beliebigen Schlüssels. Bestätigen Sie die Löschung im Dialog.

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

Altmodische Schlüssel

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

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

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

Weiter von API Schlüsseln

Wenn Sie API Schlüssel to plan dashboard and API operations, connect it with API- API Übersicht für die Implementierungsdetails in __CAPGO_KEEP_0__ Übersicht, API Schlüssel zur Implementierungsdetail in API Schlüssel, Geräte zur Implementierungsdetail in Geräte, und Pakete zur Implementierungsdetail in Pakete.