Access-Control-Referenz
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Capgo nutzt rollenbasierte Zugriffskontrolle (RBAC) um zu steuern, was jedes Teammitglied tun kann. Rollen sind nach Scope — von der gesamten Organisation bis hin zu einem einzelnen Bundle.
Für eine visuelle Anleitung zur Verwaltung von Mitgliedern im Dashboard siehe Organisation.
Rollen-Scopes
Abschnitt mit dem Titel „Rollenbereiche“Jede Rolle gehört zu einem Bereich, der bestimmt, auf welche Ressource sie Zugriff gewährt.
| Umfang | Gilt für | Beispielanwendungsfall |
|---|---|---|
| Organisation | Die gesamte Organisation und alle ihre Apps | Dein Mitgründer erhält Super Admin; dein Buchhalter erhält Billing Manager |
| App hinzu | Eine einzelne App und ihre Channels | Ein Freelancer an einer App erhält die Rolle App Developer |
| Kanal | Ein einzelner Channel innerhalb einer App | Ein QA-Engineer verwaltet nur den staging Channel |
| Bundle | Eine einzelne Bundle-Version | Ein Reviewer benötigt Lesezugriff auf ein bestimmtes Release |
Ein Mitglied kann pro Scope-Ziel eine Rolle innehaben — z. B. eine Org-Rolle, eine Rolle für App A und eine andere für App B.
Organisationsrollen
Abschnitt „Organisationsrollen“Diese Rollen werden beim Einladen eines Mitglieds zugewiesen. Sie gewähren Zugriff auf die gesamte Organisation.
| Rolle | Interner Name | Beschreibung |
|---|---|---|
| Super-Admin | org_super_admin | Entspricht dem Owner. Volle Kontrolle, inklusive Löschen der Org, Abrechnungsmanagement und App-Transfer. Wird dem Org-Ersteller automatisch zugewiesen. |
| Admin | org_admin | Vollständige Administration — Mitglieder, Apps und Channels verwalten. Kann die Organisation nicht löschen, Abrechnungen nicht ändern, Apps nicht übertragen oder Nutzer zu Super Admins befördern. |
| Abrechnungsmanager | org_billing_admin | Nur Billing-Zugriff: Abrechnungsdaten, Rechnungen und Billing-Audit-Logs einsehen und aktualisieren. Kein Zugriff auf Apps oder Mitglieder. |
| Mitglied | org_member | Nur-Lesezugriff auf die Organisation und alle ihre Apps. |
Berechtigungsmatrix der Organisation
Abschnitt mit dem Titel „Berechtigungsmatrix der Organisation“| Berechtigung | Beschreibung | Super-Admin | Admin | Abrechnungsmanager | Mitglied |
|---|---|---|---|---|---|
org.read | Organisation anzeigen | ✅ | ✅ | ✅ | ✅ |
org.update_settings | Org-Name, Logo und Management-E-Mail bearbeiten | ✅ | ✅ | ❌ | ❌ |
org.delete | Organisation dauerhaft löschen | ✅ | ❌ | ❌ | ❌ |
org.read_members | Mitgliederliste anzeigen | ✅ | ✅ | ❌ | ✅ |
org.invite_user | Neue Mitglieder einladen | ✅ | ✅ | ❌ | ❌ |
org.update_user_roles | Mitgliederrollen ändern (Admin kann niemanden zum Super Admin befördern – blockiert durch die Rollenhierarchie) | ✅ | ✅ | ❌ | ❌ |
org.read_billing | Abrechnungsinfos und aktuellen Plan anzeigen | ✅ | ✅ | ✅ | ❌ |
org.update_billing | Zahlungsmethode und Plan aktualisieren | ✅ | ❌ | ✅ | ❌ |
org.read_invoices | Rechnungen anzeigen | ✅ | ✅ | ✅ | ❌ |
org.read_audit | Aktivitätsprotokoll der Organisation anzeigen | ✅ | ✅ | ❌ | ❌ |
org.read_billing_audit | Abrechnungsbezogenes Audit-Log anzeigen | ✅ | ✅ | ✅ | ❌ |
App-Rollen
Abschnitt mit dem Titel „App-Rollen“Beschränkt auf eine einzelne App. Nutze diese, wenn ein Teammitglied nur an einer App und nicht an der gesamten Organisation arbeiten soll.
| Rolle | Interner Name | Beschreibung |
|---|---|---|
| App-Admin | app_admin | Volle Kontrolle über eine App – Kanäle, Geräte, Benutzerrollen für die App. Die App kann nicht gelöscht oder übertragen werden (das sind Operationen auf Organisationsebene). |
| App-Entwickler | app_developer | Bundles hochladen, Geräte verwalten, native Builds auslösen, Kanaleinstellungen aktualisieren. Kein Löschen, keine Änderungen an App-Einstellungen, keine Kanalerstellung. |
| App-Uploader | app_uploader | Lesezugriff + neue Bundle-Versionen hochladen. |
| App-Reader | app_reader | Nur Lesezugriff – Statistiken, Bundles, Kanäle, Logs, Geräte. |
| App-Vorschau | app_preview | An Organisation und App gebundener Preview-CI-Lebenszyklus: ein Bundle hochladen und einen Preview-Kanal erstellen. Das Erstellen dieses Kanals gewährt automatisch Lebenszyklusrechte nur für diesen Kanal. |
Berechtigungsmatrix der App
Abschnitt mit dem Titel „App-Berechtigungsmatrix“| Berechtigung | Beschreibung | App-Admin | App-Entwickler | App-Uploader | App-Reader |
|---|---|---|---|---|---|
app.read | App-Details, Stats und Metadaten einsehen | ✅ | ✅ | ✅ | ✅ |
app.update_settings | App-Einstellungen bearbeiten | ✅ | ❌ | ❌ | ❌ |
app.read_bundles | Liste der hochgeladenen Bundles anzeigen | ✅ | ✅ | ✅ | ✅ |
app.upload_bundle | Neue Bundle-Version hochladen | ✅ | ✅ | ✅ | ❌ |
app.create_channel | Neuen Channel erstellen | ✅ | ❌ | ❌ | ❌ |
app.read_channels | Channels anzeigen | ✅ | ✅ | ✅ | ✅ |
app.read_logs | Update-Delivery-Logs anzeigen | ✅ | ✅ | ✅ | ✅ |
app.manage_devices | Geräte zuweisen, überschreiben oder entkoppeln | ✅ | ✅ | ❌ | ❌ |
app.read_devices | Geräteliste anzeigen | ✅ | ✅ | ✅ | ✅ |
app.build_native | Native Cloud Build auslösen | ✅ | ✅ | ❌ | ❌ |
app.read_audit | Aktivitätsprotokoll auf App-Ebene anzeigen | ✅ | ✅ | ✅ | ✅ |
app.update_user_roles | App-spezifische Rollenzuweisungen verwalten | ✅ | ❌ | ❌ | ❌ |
bundle.delete | Bundle löschen | ✅ | ❌ | ❌ | ❌ |
Berechtigungsset für App Preview
Abschnitt mit dem Titel „App Preview-Berechtigungssatz“Nutzt App-Vorschau (app_preview) für einen organisations- und app-gebundenen CI-Key, der den PR-Preview-Lifecycle verwaltet, ohne weitreichenden App- oder organisationsweiten Zugriff.
Der app_preview Die Bindung gewährt nur diese Berechtigungen auf App-Ebene:
| Berechtigung | Erlaubt |
|---|---|
app.read | Die ausgewählte App lesen |
app.read_bundles | Hochgeladene Bundles lesen |
app.upload_bundle | Ein Bundle hochladen |
app.create_channel | Einen Channel erstellen |
Wenn ein App Preview Key einen Channel erstellt, weist Capgo diesem Key automatisch ein Child- channel_preview Binding nur für den neuen Channel zu:
| Berechtigung | Erlaubt |
|---|---|
channel.read | Den vom Key erstellten Channel lesen |
channel.promote_bundle | Das eigene hochgeladene Bundle des Keys auf diesem Channel setzen |
channel.delete | Diesen Channel löschen |
Da app_preview behält app.read, kann der Schlüssel Channel-Metadaten in der ausgewählten App auflisten. Die automatische Kindbindung ist eine Verwaltung Grenze: Der Key erlaubt keine Lifecycle-Änderungen an einem Channel, den er nicht erstellt hat.
Capgo protokolliert den Preview-Key, der jeden Channel erstellt und jedes Bundle hochgeladen hat. Daher kann ein App-Preview-Key jeden nicht öffentlichen Preview-Channel, den er benötigt, erstellen, sein eigenes Bundle promoten und diesen Channel und das Bundle atomar mit channel delete --delete-bundle; das kann er bei einem bestehenden Default-/Main-Channel, dem Channel eines anderen Preview-Keys oder dem Bundle eines anderen Keys nicht tun.
Es enthält nicht app.update_settings, Geräte- oder Rollenverwaltung, channel.update_settings, channel.rollback_bundle, erzwungene Geräteverwaltung oder generische bundle.delete.
Channel-Rollen
Abschnitt „Channel-Rollen“Gilt nur für einen einzelnen Channel. Nützlich, um gezielten Zugriff auf einen bestimmten Release-Channel zu gewähren.
| Rolle | Interner Name | Beschreibung |
|---|---|---|
| Channel-Admin | channel_admin | Volle Kontrolle über einen Channel: Einstellungen, Bundles promoten/zurückrollen, Forced Devices verwalten. |
| Channel-Betrachter | channel_reader | Read-only — aktuelles Bundle, Historie, Forced Devices, Audit-Log. |
| Channel-Vorschau | channel_preview | Vom System dem App Preview Key zugewiesen, der den Channel erstellt hat: Lesen, eigenes Bundle promoten und den Channel löschen. |
Channel-Berechtigungsmatrix
Abschnitt mit dem Titel „Channel-Berechtigungsmatrix“| Berechtigung | Beschreibung | Channel-Admin | Channel-Betrachter | Channel-Vorschau |
|---|---|---|---|---|
channel.read | Channel und das aktuelle Bundle anzeigen | ✅ | ✅ | ✅ |
channel.update_settings | Kanaleinstellungen bearbeiten (Plattform-Toggles, Update-Policy…) | ✅ | ❌ | ❌ |
channel.delete | Kanal löschen | ✅ | ❌ | ✅ |
channel.read_history | Bundle-Zuweisungsverlauf anzeigen | ✅ | ✅ | ❌ |
channel.promote_bundle | Das aktive Bundle für den Kanal festlegen | ✅ | ❌ | ✅ |
channel.rollback_bundle | Auf ein vorheriges Bundle zurückrollen | ✅ | ❌ | ❌ |
channel.manage_forced_devices | Bestimmte Geräte diesem Kanal fest zuweisen | ✅ | ❌ | ❌ |
channel.read_forced_devices | Liste der fest zugewiesenen Geräte anzeigen | ✅ | ✅ | ❌ |
channel.read_audit | Kanal-Aktivitätsprotokoll anzeigen | ✅ | ✅ | ❌ |
Bundle-Rollen
Abschnitt „Bundle-Rollen“Beschränkt auf eine einzelne Bundle-Version. Selten benötigt – die meisten Teams nutzen stattdessen Rollen auf App-Ebene.
| Rolle | Interner Name | Beschreibung |
|---|---|---|
| Bundle-Admin | bundle_admin | Ein bestimmtes Bundle lesen, Metadaten aktualisieren und löschen. |
| Bundle-Viewer | bundle_reader | Nur-Lese-Zugriff auf ein bestimmtes Bundle. |
Channel-Berechtigungs-Overrides (Dashboard)
Abschnitt mit dem Titel „Channel-Berechtigungs-Overrides (Dashboard)“Im Dashboard wird der Channel-Zugriff standardmäßig durch die App-Rolle des Benutzers bestimmt. Für eine feinere Steuerung können Sie bestimmte Channel-Berechtigungen überschreiben pro Benutzer oder Gruppe, ohne deren App-Rolle zu ändern.
Overrides are configured from the app’s Auskunft Tab, indem Sie auf die Schaltfläche „Kanalberechtigungen“ (Schild-Symbol) neben einem Benutzer klicken. Siehe Organisation — Channel-Berechtigungen überschreiben für einen visuellen Überblick.
Überschreibbare Berechtigungen
Abschnitt mit dem Titel „Überschreibbare Berechtigungen“| Berechtigung | Beschreibung | Standardverhalten |
|---|---|---|
| Lies | Channel und das aktuelle Bundle anzeigen | Von der App-Rolle geerbt |
| Verlauf | Verlauf der Bundle-Zuweisungen anzeigen | Von der App-Rolle geerbt |
| Bundle zuordnen | Aktives Bundle auf dem Channel setzen oder ändern | Von der App-Rolle geerbt |
Jede Berechtigung kann wie folgt festgelegt werden:
- Standard — von der App-Rolle erben (Standard)
- Erlauben — explizit gewähren, unabhängig von der App-Rolle
- Verweigern — explizit blockieren, unabhängig von der App-Rolle
So können Sie beispielsweise einem App Reader die Möglichkeit geben, Bundles auf dem staging Channel zu verknüpfen, ohne ihn zum App Developer hochzustufen.
Rollenhierarchie
Abschnitt mit dem Titel „Rollenhierarchie“Rollen bilden eine Hierarchie. Eine übergeordnete Rolle erbt alle Berechtigungen ihrer untergeordneten Rollen. Das bedeutet, dass eine org_admin kann alles, was ein app_admin alles kann, was wiederum alles kann, was eine channel_admin kann, und so weiter.
Super Admin (org_super_admin) └── Admin (org_admin) └── App Admin (app_admin) ├── App Developer (app_developer) │ └── App Uploader (app_uploader) │ └── App Reader (app_reader) ├── Bundle Admin (bundle_admin) │ └── Bundle Viewer (bundle_reader) └── Channel Admin (channel_admin) └── Channel Viewer (channel_reader)So funktioniert es in der Praxis:
- Ein Admin auf Org-Ebene kann alles tun, was ein App-Admin kann, für jede App in der Org.
- Ein App-Admin für eine bestimmte App alles, was ein Channel-Admin kann, für jeden Channel in dieser App.
- Ein App-Entwickler kann alles, was ein App-Uploader kann, plus mehr.
Die Hierarchie fließt nur nach unten — ein channel_admin erhält niemals Berechtigungen auf Organisationsebene, selbst wenn er auch eine App-Rolle hat.
Statt jedem Benutzer einzeln Rollen zuzuweisen, können Sie Gruppen erstellen und Rollen der Gruppe zuweisen. Jedes Gruppenmitglied erbt diese Rollen automatisch.
So funktionieren Gruppen
Abschnitt mit dem Titel „So funktionieren Gruppen“- Eine Gruppe gehört zu eine Organisation — sie kann nicht mehrere Orgs umfassen.
- Gruppen können Rollenbindungen auf jeder Ebene: Org, App, Channel oder Bundle. Beispielsweise kann einer Gruppe die App-Entwickler Rolle für App A und die Channel-Admin Rolle für den
stagingChannel von App B. - Bei der Prüfung der Berechtigungen eines Benutzers werden alle Gruppenmitgliedschaften transparent aufgelöst. Wenn eine seiner Gruppen die erforderliche Berechtigung gewährt, wird der Zugriff freigegeben.
- Ein Benutzer kann zu mehrere Gruppen, und Berechtigungen aus allen Gruppen addieren sich.
- Gruppenbasierte Berechtigungen gelten nur für User-Principals — API Keys erben keine Gruppenrollen.
Wann Gruppen sinnvoll sind
Abschnitt mit dem Titel „Wann Gruppen sinnvoll sind“| Szenario | Ohne Gruppen | Mit Gruppen |
|---|---|---|
| 5 QA-Engineers benötigen Developer-Zugriff auf 3 Apps | 15 einzelne Role-Bindings | 1 Gruppe + 3 Rollenbindungen |
| Jemand tritt dem QA-Team bei | 3 Rollenbindungen manuell hinzufügen | Diese der Gruppe hinzufügen |
| Jemand verlässt das QA-Team | 3 Rollenbindungen manuell entfernen | Diese aus der Gruppe entfernen |
Gruppen über API verwalten
Abschnitt mit dem Titel „Gruppen über API verwalten“Alle Gruppen-Endpoints erfordern Authentifizierung und laufen unter /private/groups.
Gruppen auflisten
Abschnitt mit dem Titel „Gruppen auflisten“curl -X GET "https://api.capgo.app/private/groups/<ORG_ID>" \ -H "authorization: <API_KEY>"Erfordert org.read_members Berechtigung.
Gruppe erstellen
Abschnitt mit dem Titel „Gruppe erstellen“curl -X POST "https://api.capgo.app/private/groups/<ORG_ID>" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "QA Team", "description": "Quality assurance engineers" }'Erfordert org.update_user_roles Berechtigung (Super-Admin oder Admin).
Gruppe aktualisieren
Abschnitt mit dem Titel „Gruppe aktualisieren“curl -X PUT "https://api.capgo.app/private/groups/<GROUP_ID>" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "QA Team", "description": "Updated description" }'Gruppe löschen
Abschnitt mit dem Titel „Gruppe löschen“curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>" \ -H "authorization: <API_KEY>"Beim Löschen einer Gruppe werden auch alle ihre Rollenbindungen entfernt. Mitglieder werden nicht aus der Organisation gelöscht.
Gruppenmitglieder auflisten
Section titled “List group members”curl -X GET "https://api.capgo.app/private/groups/<GROUP_ID>/members" \ -H "authorization: <API_KEY>"Mitglied zu einer Gruppe hinzufügen
Section titled “Add a member to a group”curl -X POST "https://api.capgo.app/private/groups/<GROUP_ID>/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "user_id": "<USER_UUID>" }'Der Nutzer muss bereits Mitglied der Organisation sein. Das Hinzufügen eines bereits vorhandenen Mitglieds ist ein No-op.
Mitglied aus einer Gruppe entfernen
Abschnitt mit dem Titel „Mitglied aus einer Gruppe entfernen“curl -X DELETE "https://api.capgo.app/private/groups/<GROUP_ID>/members/<USER_UUID>" \ -H "authorization: <API_KEY>"Rollen zuweisen via API
Abschnitt mit dem Titel „Rollen zuweisen via API“Mitglieder auflisten
Abschnitt „Mitglieder auflisten“curl -X GET "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>" }'Antwort:
[ { "uid": "user-uuid", "email": "alice@example.com", "image_url": "https://...", "role": "org_admin", "is_tmp": false }]Mitglied einladen
Abschnitt mit dem Titel „Mitglied einladen“curl -X POST "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>", "email": "bob@example.com", "invite_type": "org_admin" }'Zulässige Werte für invite_type:
| Wert | Zugewiesene Rolle |
|---|---|
org_super_admin | Super-Admin |
org_admin | Admin |
org_billing_admin | Abrechnungsmanager |
org_member | Mitglied |
Mitglied entfernen
Abschnitt „Mitglied entfernen“curl -X DELETE "https://api.capgo.app/organization/members" \ -H "authorization: <API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "orgId": "<ORG_ID>", "email": "bob@example.com" }'Rollen zuweisen über CLI
Abschnitt „Rollen zuweisen über CLI“Organisationen auflisten
Abschnitt „Organisationen auflisten“npx @capgo/cli organization list --apikey <API_KEY>Mitglieder auflisten
Abschnitt „Mitglieder auflisten“npx @capgo/cli organization members <ORG_ID> --apikey <API_KEY>Benutzerdefinierte Rollen
Abschnitt mit dem Titel „Benutzerdefinierte Rollen“Die integrierten Rollen decken die meisten Teamstrukturen ab. Die Erstellung benutzerdefinierter Rollen ist in unserer Roadmap – falls Ihr Team dies benötigt, nehmen Sie Kontakt mit uns auf. Ihr Use Case hilft uns dabei, diese Funktion priorisieren zu können.
Weiter mit der Referenz für Zugriffskontrolle
Abschnitt mit dem Titel „Weiter mit der Referenz für Zugriffskontrolle“Wenn du es nutzt Access-Control-Referenz um Dashboard- und API-Operationen zu planen, verbinde es mit API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für die Implementierungsdetails in API Keys, Geräte für die Implementierungsdetails in Devices und Bundles für die Implementierungsdetails in Bundles.