Mitglieder

Mitglieder einer Organisation sind Benutzer, die Zugriff auf Ihre Capgo Organisation haben. Jedes Mitglied hat eine bestimmte Rolle, die ihre Berechtigungen innerhalb der Organisation bestimmt. Die effektive Mitgliederverwaltung ist entscheidend für die Sicherheit und Zusammenarbeit in Ihrem Team.

Mitgliederrollen

Regelmäßige Rollen

• Lesen: Kann Ressourcen anzeigen, aber keine Änderungen vornehmen
• : Kann neue Bundles hochladen und Ressourcen anzeigen: Kann Ressourcen hochladen und neue Bundles hochladen
• upload: Ressourcen können modifiziert und Bundel hochgeladen werden
• admin: Organisationseinstellungen und Mitglieder können verwaltet werden
• super_admin: Die Organisation vollständig kontrollieren

Einladungszugriffe

• Einladung zum LesenEinladung zum Hochladen
• Einladung zum Schreiben: Einladung zum Lesen wartet auf Bestätigung
• : Einladung zum Hochladen wartet auf Bestätigung: Einladung für die Schreibzugriffserweiterung wartet
• invite_admin: Einladung für den Admin-Zugriff wartet
• invite_super_admin: Einladung für den Super-Admin-Zugriff wartet

Best Practices

1. Rollenzuweisung: Ziehen Sie bei der Zuweisung von Rollen das Grundsatz der geringsten Privilegien an
2. Regelmäßige Audits: Überprüfen Sie regelmäßig den Zugriff von Mitgliedern und entfernen Sie nicht genutzte Konten
3. Onboarding: Haben Sie einen klaren Prozess für die Aufnahme neuer Mitglieder und die Zuweisung von Rollen
4. Offboarding: Entfernen Sie Zugriff für Mitglieder, die die Organisation verlassen

Endpoints

POST

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

Fügen Sie einem Organisation oder aktualisieren Sie die Rolle eines bestehenden Mitglieds. Beachten Sie, dass Sie nur Benutzer einladen können, die bereits ein Capgo-Konto haben - die E-Mail muss einem bestehenden Capgo-Benutzer entsprechen.

Request Body

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

Beispielanfrage

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/

Erfolgsantwort

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

Hinweis:

• Wenn ein neuer Mitglied hinzugefügt wird, erhalten sie eine Einladungsemail. Ihre Rolle wird mit „invite_“ vorangestellt, bis sie die Einladung annehmen.
• Der Benutzer muss bereits ein Capgo-Konto besitzen, bevor er eingeladen werden kann. Wenn sie kein Konto haben, sollten sie zunächst eines bei https://console.capgo.app/register/

GET

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

Alle Mitglieder einer Organisation abrufen.

Abfrageparameter

interface MemberQuery {
  orgId: string
}

Antworttyp

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

Beispielanfrage

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

Beispielergebnis

{
  "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/

Ein Mitglied aus einer Organisation entfernen. Dies wird sofort ihren Zugriff entziehen.

Anforderungskörper

interface MemberDelete {
  orgId: string
  email: string
}

Beispielanfrage

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/

__CAPGO_KEEP_0__

{
  "status": "OK"
}

Fehlerbehandlung

Häufige Fehlerfälle und ihre Antworten:

// Member not found
{
  "error": "Member not found",
  "status": "KO"
}

// Invalid role
{
  "error": "Invalid role specified",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage members",
  "status": "KO"
}

// Cannot remove last admin
{
  "error": "Cannot remove the last admin from the organization",
  "status": "KO"
}

// Invalid email
{
  "error": "Invalid email format",
  "status": "KO"
}

// Member already exists
{
  "error": "Member already exists in organization",
  "status": "KO"
}

Gemeinsame Verwendungsfälle

1. Team-ErweiterungHinzufügen neuer Teammitglieder mit geeigneten Rollen
2. ZugriffssteuerungMitgliederechtigungen im Laufe von Änderungen der Verantwortlichkeiten verwalten
3. SicherheitsauditMitgliederliste und Rollen regelmäßig überprüfen
4. TeamumstrukturierungRollen bei organisatorischen Änderungen aktualisieren