API Schlüssel

API-Schlüssel verwenden die role-basierte 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. Für die geringste Privilegien sollten Sie einen Schlüssel auf ausgewählte Anwendungen beschränken, 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 role-basierte 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. Besetzen Sie die Schlüsselinformationen:

   • Name (Pflichtfeld) — 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.
   • Setzen Sie eine Ablaufzeit (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 die Grundrechte innerhalb der Organisation festzulegen. Die verfügbaren Rollen hängen von Ihrem eigenen Rollenlevel ab:
     • Keine — Keine Organisationsebene-Zugriffsberechtigung.
     • Mitglied — Grundlegender Leserecht Zugriff auf die Organisation.
     • Administrator — Vollständiger Administratorzugriff auf die Organisation und alle ihre Apps.
   • Apps nur Zugriff — Aktivieren Beschränken Sie diesen Schlüssel auf ausgewählte Apps. Jedes App-Bindung bleibt mit derjenigen App verbunden, die der Organisation gehört; Diese Modus umfasst nur eine Organisationsebene RBAC-Rolle.

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

   Dies fügt die globale org.create Ermächtigung hinzu. Der Schlüssel benötigt auch eine organisationsspezifische org_admin oder org_super_admin HTML-Textfragment aus einem längeren Capgo-UI-String (Elternschlüssel `alternatives_cta_questions`). Seite/Bereich: Seite zur Vergleichsübersicht von Capacitor-Live-Update-Alternativen. Rolle: Langen Marketing- oder Rechtsparagraphen. Gesehen in: Seite alternatives.astro. Produkt- und Markenbezeichnungen von Capgo sowie Entwicklertermen bleiben genau erhalten. Nachrichtenschlüssel `alternatives_cta_questions` (Alternativen-CTA-Fragen). | HTML-Textfragment aus einem längeren Capgo-UI-String (Elternschlüssel `appflow_cta_questions`). Seite/Bereich: Seite zur Vergleichs- und Migrationswerbung für Appflow. Rolle: Langen Marketing- oder Rechtsparagraphen. Gesehen in: Seite ionic-appflow.astro. Produkt- und Markenbezeichnungen von Capgo sowie Entwicklertermen bleiben genau erhalten. Nachrichtenschlüssel `appflow_cta_questions` (Appflow-CTA-Fragen). | HTML-Textfragment aus einem längeren Capgo-UI-String (Elternschlüssel `capwesome_cta_questions`). Seite/Bereich: Seite zur Vergleichsübersicht von Capawesome. Rolle: Langen Marketing- oder Rechtsparagraphen. Gesehen in: Seite capwesome.astro. Produkt- und Markenbezeichnungen von Capgo sowie Entwicklertermen bleiben genau erhalten. Nachrichtenschlüssel `capwesome_cta_questions` (Capwesome-CTA-Fragen). | HTML-Textfragment aus einem längeren Capgo-UI-String (Elternschlüssel `consulting_faq_subtitle`). Seite/Bereich: Seite zu den Beratungsleistungen. Rolle: Untertitel oder Slogan. Gesehen in: Seite consulting.astro. Produkt- und Markenbezeichnungen von Capgo sowie Entwicklertermen bleiben genau erhalten. Nachrichtenschlüssel `consulting_faq_subtitle` (Beratungs-FAQ-Untertitel). | Seite/Bereich: Seite zur Vergleichs- und Migrationswerbung für Appflow. Rolle: Kurzer UI-Label oder Navigationspunkt. Gesehen in: Seite ionic-appflow.astro, Seite ionic-enterprise-plugins.astro, Seite solutions/ionic-enterprise-plugins.astro. Nachrichtenschlüssel `appflow_plugins_or` (Appflow-Plugins-oder). Dieses fügt die globale Ermächtigung hinzu. Im Dashboard wird die Auswahl von org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

5. erstellt die

   • Ermächtigung. 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 App-Zugriff zu gewähren: Wenn Limit this key to selected apps um seine Apps zu enthüllen. Die ausgewählten App-Bindungen bleiben mit ihren eigenen Organisationen verbunden; diese Filter gewährt keine Organisationseinheit-Zugriff.
   • Klicken Sie “+ App hinzufügen”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 kann.
     • App-Entwickler — Neuere Pakete hochladen, Geräte verwalten, native Builds auslösen und Kanal-Einstellungen aktualisieren kann.
     • App-Admin — Vollzugriff auf die App.
     • App-Vorschau — Vorschau CI/CD-Zyklus: Laden Sie ein Bundle hoch und erstellen Sie einen Vorschaukanal. Der Kanal erhält automatische, kanal-grenzende Lebenszyklusrechte nur für diese Schlüssel.

6. Klicken Sie “Erstellen”.

7. Wenn Sie angeklickt haben Sicheren Schlüssel erstellen, ein Modalfenster mit dem plain-text-Schlüssel wird angezeigt. 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

Benutzen 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 Zugriff auf das Lebenszyklus eines bestehenden Standard- oder Hauptkanals.

1. Erstelle eine RBAC-Schlüssel und aktiviere Einschränke diesen Schlüssel auf ausgewählte Apps.
2. Unter Organisationen filtern, um Apps auszuwählen, wähle die Organisation, um ihre Apps anzuzeigen; jede ausgewählte App bleibt mit ihrer eigenen Organisation verbunden.
3. Füge nur die App oder Apps hinzu, die für Vorschau-Deployments verwendet werden.
4. Wähle App-Vorschau Für jede ausgewählte App.
5. Erstellen Sie einen sicheren Schlüssel, setzen Sie eine Ablaufzeit, wenn dies angebracht ist, und speichern Sie ihn in Ihrem CI-Secret-Manager.

Diese ausgewählten-Anwendungen- nur-Modus lässt eine Organisationseinheit-Rolle aus; es tut nicht app_preview den Organisationseinheits-Verknüpfung entfernen. Jedes

Bindung bleibt auf die ausgewählte Anwendung und die von dieser Anwendung besitzende Organisation beschränkt.	Erlauben Sie
app_preview Berechtigungen und Grenzen	app.read, app.read_bundles, app.upload_bundleauf der ausgewählten Anwendung app.create_channel.
, und channel_preview Automatische	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, so 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. Die letzte Anweisung verwendet eine enge atomische Reinigungsroute: Sie gelingt nur, wenn die Schlüssel den Vorschaukanal und dessen verbundenes, nicht geteiltes Bundle besitzt. App-Vorschau hat noch keine allgemeine bundle.deleteerhalten, sodass es einen beliebigen Bundle nicht löschen kann.

Vorsicht

Verwenden Sie einen neuen nicht öffentlichen pr-<number> Kanal. Passen Sie keine --default, --self-assignRolle-Optionen oder --delete-linked-bundle-on-upload 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 fördern, löschen oder ändern. Die Rücknahme oder das Ablaufdatum der App-Bindung 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.
• aktualisieren oder deaktivieren Erstellen von Organisationen zulassen wenn der Schlüssel eine Admin-Rolle in einer Organisation hat.
• Hinzufügen, entfernen oder ändern Anwendungsrollen.

Klicken “Änderungen speichern” wenn fertig.

Wie kann man einen API Schlüssel neu generieren?

Um den geheimen Wert 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 (gehashpte) 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üllartige Icon (Löschen) in jeder Schlüsselliste. Bestätigen Sie die Löschung im Dialog.

Der Schlüssel wird sofort zurückgezogen — jede Anfrage, die ihn verwendet, schlägt fehl.

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 nicht die Vorteile des RBAC-fine-granularen Berechtigungssystems.

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 for the implementation detail in API Overview, __CAPGO_KEEP_0__ Übersicht für die Implementierungsdetails in der __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.