API Schlüssel

API-Schlüssel verwenden die Rollebasierte Zugriffssteuerung (RBAC). Ein Schlüssel kann eine Organisationsebene-Rolle, App-basierte Bindungen oder beide haben. Jede App-Bindung bleibt mit der zugehörigen App verbunden. Für die geringste Privilegien sollten Sie einen Schlüssel auf ausgewählte Apps beschränken, anstatt eine Organisationsebene-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. Die Schlüsselinformationen:

   • Name (erforderlich) — Eine beschreibende Bezeichnung für den Schlüssel (z. B. „CI/CD Deploy“ oder „Monitoring Read-Only“).
   • Sichere Schlüssel erstellen (optional) — Wenn aktiviert, wird der Schlüssel serverseitig gehasht. Der plain-text-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.
   • Ablaufdatum festlegen (optional) — Wählen Sie einen Zeitpunkt, ab dem 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 Basisrechte innerhalb der Organisation festzulegen. Verfügbar sind Rollen, die von Ihrem eigenen Rollenlevel abhängen:
     • Keine — Keine Organisationsebene-Zugriffsberechtigung.
     • Mitglied — Grundlegender Leserecht Zugriff 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 der App verbunden, die der Organisation gehört; Diese Modus verweist nur auf 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 organisationsskalierte org_admin oder org_super_admin Zulassung. Die Schlüssel benötigt auch eine organisationsskalierte Zulassung. In der Konsole wird durch Auswahl von Admin org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. Zulassung erstellt. Wenn dieser Schlüssel eine neue Organisation erstellt, wird __CAPGO_KEEP_0__ der Schlüssel automatisch als Super Admin auf dieser neuen Organisation zugewiesen.

   • Um Anwendungen Zugriff zu gewähren: Wenn Limitiert auf ausgewählte Apps aktiviert ist, wählen Sie eine Organisation unter um seine Apps zu enthüllen. Die ausgewählten App-Bindungen bleiben mit ihren eigenen Organisationen verbunden; diese Filter gewährt keine Organisationsebene-Zugriff.
   • Klicken Sie ”+ Add App”Add App“
     • , wählen Sie eine oder mehrere Apps aus, und zuweisen Sie dann eine Rolle zu jeder: App-Leser
     • — Nur-Lesezugriff auf die App. App-Uploader
     • — Kann neue Pakete hochladen. App-Entwickler
     • — Kann Pakete hochladen, Geräte verwalten, native Builds auslösen und Kanal-Einstellungen aktualisieren. App-Admin
     • App-Vorschau — Vorschau des CI/CD-Zyklus: 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 angeklickt haben Sicheren Schlüssel erstellen, dann wird ein Modalfenster angezeigt, in dem der Schlüssel als Plain-Text angezeigt wird. 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 beide den Kanal und das Paket entfernt. Es hat keinen Lebenszyklus-Zugriff auf einen bestehenden Standard- oder Hauptkanal.

1. Erstellen Sie einen RBAC-Schlüssel und aktivieren Sie Einschränken Sie diesen Schlüssel auf ausgewählte Apps.
2. Unter Organisationen filtern Sie Apps, wählen Sie die Organisation aus, um ihre Apps anzuzeigen; 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 es 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 von dieser Anwendung besitzende Organisation 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":"Page/area: Capgo solutions marketing page. Role: Short UI label or navigation item. Seen in: page solutions/pr-preview.astro. Message key `solutions_pr_step1_time` (Solutions Pr Step1 Time)." channel_preview Bindung	Wenn dieser Schlüssel einen Kanal erstellt, Capgo gibt dem Schlüssel automatisch channel.read, channel.promote_bundleund channel.delete nur für diesen Kanal.

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

Capgo registriert auch, welcher App-Vorschau-Schlüssel ein Bundle hochgeladen hat. Die Schlüssel kann nur ihr eigenes Bundle auf jedem Vorschaukanal erstellen, den sie erstellt, und kann diese Paar zusammen löschen. Sie 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ür einen typischen CI-Auftrag verwenden Sie einen eindeutigen Kanalnamen pro Pull-Request:

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ür einen neuen Kanal bundle upload --channel erstellt den Kanal, lädt das Bundle hoch und promotet es in einem Flow. Der letzte Befehl verwendet eine enge atomische Reinigungsroute: Er gelingt nur, wenn die Schlüssel den Vorschaukanal und sein verbundenes, nicht geteiltes Bundle besitzt. App-Vorschau hat noch keine allgemeine bundle.deleteFunktion, daher kann sie einen beliebigen Bundle nicht löschen.

Vorsicht

Verwende einen neuen, nicht öffentlichen pr-<number> Kanal. Übertrage keine --default, --self-assignRollenoptionen oder --delete-linked-bundle-on-upload diesem Workflow. Ein App-Vorschau Schlüssel kann keine 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 (bearbeiten) einen API-Schlüssel?

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 Organisationsberechtigungslevel.
• aktivieren oder deaktivieren Erstellen von Organisationen zulassen wenn die Taste eine Admin-Rolle in der Organisation hat.
• Hinzufügen, entfernen oder ändern Rollen pro Anwendung.

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 (Regenerate) auf jeder Schlüssel in der Liste.

Ein Bestätigungsdialog erscheint. Nach Bestätigung:

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

Jede Integration mit dem alten Schlüsselwert funktioniert sofort nicht mehr.

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

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 Altmodische 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 RBAC-feinen 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 der Seite console.capgo.app/dashboard/apikeys , finden. Diese Seite ist veraltet und wird in einer zukünftigen Aktualisierung entfernt.

Weiter mit API Schlüsseln

Wenn Sie API Schlüsseln verwenden, um das Dashboard und API-Operationen zu planen, verbinden Sie es mit API Überblick for the implementation detail in API Overview, __CAPGO_KEEP_0__ Überblick zu sehen, und für die Implementierungsdetails in API Schlüssel für die Implementierungsdetails in API Schlüssel Geräte für die Implementierungsdetails in Geräte, und Bundles für die Implementierungsdetails in Bundles.