Mitglieder

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

Standardrollen

• read-: Kann Ressourcen einsehen, aber keine Änderungen vornehmen
• Upload: Kann neue Bundles hochladen und Ressourcen einsehen
• write: Darf Ressourcen ändern und Bundles hochladen
• admin: Darf Organisationseinstellungen und Mitglieder verwalten
• Super-Admin: Hat die volle Kontrolle über die Organisation

Einladungsrollen

• Mitglieder einsehen: Ausstehende Einladung mit Lesezugriff
• Einladung hochladen: Ausstehende Einladung mit Upload-Zugriff
• Mitglieder einladen: 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

1. Rollenverteilung: Wende das Prinzip der geringsten Berechtigung bei der Rollenzuweisung an
2. Regelmäßige Audits: Überprüfe regelmäßig den Mitgliederzugriff und entferne ungenutzte Accounts
3. Onboarding: Sorgen Sie für einen klaren Prozess, um neue Mitglieder hinzuzufügen und Rollen zuzuweisen
4. Offboarding: Entziehen Sie Mitgliedern, die die Organisation verlassen, umgehend den Zugriff

Endpoints

POST

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

interface MemberCreate {
  orgId: string
  email: string
  role: "read" | "upload" | "write" | "admin" | "super_admin"
}

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

{
  "status": "OK",
  "data": {
    "uid": "user_789",
    "email": "newmember@example.com",
    "role": "invite_write",
    "image_url": null
  }
}

Hinweise:

• Nach dem Hinzufügen eines neuen Mitglieds wird eine Einladungs-E-Mail versendet. Die Rolle wird mit „invite_“ vorangestellt, bis die Einladung angenommen wurde.
• Der Nutzer muss bereits ein Capgo Konto besitzen, um eingeladen werden zu können. Falls noch kein Konto vorhanden ist, sollte zuerst eines unter https://capgo.app/register/ erstellt werden.

GET

https://api.capgo.app/organization/members/

Alle Mitglieder einer Organisation abrufen.

Query-Parameter

interface MemberQuery {
  orgId: string
}

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

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/organization/members/?orgId=org_123"

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"
    }
  ]
}

DELETE

https://api.capgo.app/organization/members/

Entfernt ein Mitglied aus einer Organisation. Dadurch wird der Zugriff sofort entzogen.

Request-Body

interface MemberDelete {
  orgId: string
  email: string
}

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

{
  "status": "OK"
}

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

1. Team-Erweiterung: Neue Teammitglieder mit passenden Rollen hinzufügen
2. Zugriffskontrolle: Mitgliederberechtigungen bei Aufgabenwechsel anpassen
3. Security-Audit: Mitgliederliste und Rollen regelmäßig prüfen
4. Team-Umstrukturierung: Rollen bei organisatorischen Änderungen aktualisieren

Weiter mit Members

Wenn du es nutzt Mitglieder um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Encryption, Compliance 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.