Mitglieder
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Organisationsmitglieder sind Nutzer, die Zugriff auf deine Capgo-Organisation haben. Jedes Mitglied hat eine bestimmte Rolle, die seine Berechtigungen innerhalb der Organisation festlegt. Eine effektive Mitgliederverwaltung ist entscheidend für Sicherheit und Zusammenarbeit in deinem Team.
Mitgliederrollen
Abschnitt mit dem Titel „Mitgliederrollen“Standardrollen
Abschnitt mit dem Titel „Standardrollen“- read-: Kann Ressourcen einsehen, aber keine Änderungen vornehmen
- Upload: Kann neue Bundles hochladen und Ressourcen einsehen
- schreiben: Kann Ressourcen ändern und Bundles hochladen
- admin: Kann Organisationseinstellungen und Mitglieder verwalten
- Super-Admin: Hat die volle Kontrolle über die Organisation
Einladungsrollen
Abschnitt mit dem Titel „Einladungsrollen“- invite_read: Ausstehende Einladung für Lesezugriff
- invite_upload: Ausstehende Einladung für Upload-Zugriff
- Einladungen schreiben: Ausstehende Einladung für Schreibzugriff
- Admin einladen: Ausstehende Einladung für Admin-Zugriff
- Super-Admin einladen: Ausstehende Einladung für Super-Admin-Zugriff
Best Practices
Abschnitt mit dem Titel „Best Practices“- Rollenzuweisung: Wende bei der Rollenzuweisung das Least-Privilege-Prinzip an
- Regelmäßige Audits: Prüfe regelmäßig den Mitgliederzugriff und entferne ungenutzte Accounts
- Onboarding: Sorgen Sie für einen klaren Prozess, um neue Mitglieder hinzuzufügen und Rollen zuzuweisen
- Offboarding: Entziehen Sie Mitgliedern, die die Organisation verlassen, umgehend den Zugriff
Endpoints
Abschnitt mit dem Titel „Endpoints“https://api.capgo.app/organization/members/
Fügen Sie einer Organisation ein neues Mitglied hinzu oder aktualisieren Sie die Rolle eines bestehenden Mitglieds. Beachten Sie, dass Sie nur Nutzer einladen können, die bereits ein Capgo-Konto haben – die E-Mail-Adresse muss zu einem bestehenden Capgo-Nutzer gehören.
Request-Body
Abschnitt mit dem Titel „Request Body“interface MemberCreate { orgId: string email: string role: "read" | "upload" | "write" | "admin" | "super_admin"}Beispiel-Request
Abschnitt mit dem Titel „Beispiel-Request“curl -X POST \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "orgId": "org_123", "email": "newmember@example.com", "role": "write" }' \ https://api.capgo.app/organization/members/Erfolgreiche Antwort
Abschnitt mit dem Titel „Erfolgreiche Antwort“{ "status": "OK", "data": { "uid": "user_789", "email": "newmember@example.com", "role": "invite_write", "image_url": null }}Hinweise:
- Wenn ein neues Mitglied hinzugefügt wird, erhält es eine Einladung per E-Mail. Die Rolle wird mit „invite_“ vorangestellt, bis die Einladung akzeptiert wird.
- Der Benutzer muss bereits ein Capgo-Konto haben, bevor er eingeladen werden kann. Falls nicht, sollte er zuerst eines unter folgender Adresse erstellen: https://capgo.app/register/
https://api.capgo.app/organization/members/
Alle Mitglieder einer Organisation abrufen.
Query-Parameter
Abschnitt mit dem Titel „Query-Parameter“interface MemberQuery { orgId: string}Response-Typ
Abschnitt mit dem Titel „Response-Typ“interface Member { uid: string; email: string; image_url: string; role: "invite_read" | "invite_upload" | "invite_write" | "invite_admin" | "invite_super_admin" | "read" | "upload" | "write" | "admin" | "super_admin";}Beispiel-Request
Abschnitt mit dem Titel „Beispiel-Request“curl -H "authorization: your-api-key" \ "https://api.capgo.app/organization/members/?orgId=org_123"Beispielantwort
Abschnitt mit dem Titel „Beispielantwort“{ "data": [ { "uid": "user_123", "email": "john@example.com", "image_url": "https://example.com/avatar.png", "role": "admin" }, { "uid": "user_456", "email": "jane@example.com", "image_url": "https://example.com/avatar2.png", "role": "write" }, { "uid": "user_789", "email": "bob@example.com", "image_url": null, "role": "invite_read" } ]}https://api.capgo.app/organization/members/
Entfernt ein Mitglied aus einer Organisation. Dadurch wird der Zugriff sofort entzogen.
Request-Body
Abschnitt mit dem Titel „Request Body“interface MemberDelete { orgId: string email: string}Beispiel-Request
Abschnitt mit dem Titel „Beispiel-Request“curl -X DELETE \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "orgId": "org_123", "email": "user@example.com" }' \ https://api.capgo.app/organization/members/Erfolgreiche Antwort
Abschnitt mit dem Titel „Erfolgreiche Antwort“{ "status": "OK"}Fehlerbehandlung
Abschnitt mit dem Titel „Fehlerbehandlung“Alle Fehler verwenden das Standardfehlerformat, das in der API Übersicht.
Häufige Fehlerszenarien und deren Antworten:
// The API key has no access to the organization{ "error": "cannot_access_organization", "message": "You can't access this organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }}
// Unknown role on update{ "error": "invalid_role", "message": "Invalid role", "moreInfo": { "role": "owner" }}
// Changing the role of the user who owns the API key{ "error": "cannot_change_own_role", "message": "You cannot change your own role", "moreInfo": {}}
// Removing a user who is not a member (HTTP 404){ "error": "organization_member_not_found", "message": "User is not a member of this organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8", "email": "user@example.com" }}
// Removing the last super admin{ "error": "CANNOT_REMOVE_LAST_SUPER_ADMIN", "message": "Cannot remove the last super admin from the organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }}Häufige Anwendungsfälle
Abschnitt mit dem Titel „Häufige Anwendungsfälle“- Team-Erweiterung: Neue Teammitglieder mit passenden Rollen hinzufügen
- Zugriffskontrolle: Berechtigungen von Mitgliedern verwalten, wenn sich Zuständigkeiten ändern
- Security-Audit: Mitgliederliste und Rollen regelmäßig überprüfen
- Team-Neustrukturierung: Rollen bei organisatorischen Änderungen aktualisieren
Weiter mit Members
Abschnitt mit dem Titel „Weiter von Members“Wenn du es nutzt Mitglieder um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Encryption, Konformität für das Implementierungsdetail in Compliance, Capgo Security-Scanner für den Produkt-Workflow im Capgo Security Scanner, Capgo Sicherheit für den Produkt-Workflow in Capgo Security und Capgo Trust Center für den Produkt-Workflow im Capgo Trust Center.