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 die Zusammenarbeit in Ihrem Team.

Mitglieder-Rollen

Regelmäßige Rollen

• lesen: Kann Ressourcen ansehen, aber keine Änderungen vornehmen
• hochladen: Kann neue Pakete hochladen und Ressourcen ansehen
• schreiben: Kann Ressourcen bearbeiten und Pakete hochladen
• admin: Kann Organisationseinstellungen und Mitglieder verwalten
• super_admin: Hat volle Kontrolle über die Organisation

Einladungsrollen

• __CAPGO_KEEP_0__: Wartende Einladung für die Leserechtigkeit
• __CAPGO_KEEP_0__: Wartende Einladung für das Uploadrecht
• __CAPGO_KEEP_0__: Wartende Einladung für das Schreibrecht
• __CAPGO_KEEP_0__: Wartende Einladung für das Administratorrecht
• __CAPGO_KEEP_0__: Wartende Einladung für das Super-Administratorrecht

Gute Praktiken

1. Rollenzuweisung: Folge dem Grundsatz der kleinsten Rechte bei der Zuweisung von Rollen
2. Regelmäßige Audits: Überprüfe regelmäßig den Zugriff der Mitglieder und entferne nicht genutzte Konten
3. Einbindung: Habe einen klaren Prozess für die Hinzufügung neuer Mitglieder und die Zuweisung von Rollen
4. Ausschreibung: Entferne zeitnah den Zugriff für Mitglieder, die die Organisation verlassen

Endpunkte

POST

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

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

Anforderungskörper

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

Hinweise:

• Wenn Sie einen neuen Mitglied hinzufügen, erhalten sie eine Einladungsemail. Seine Rolle wird mit „invite_“ vorangestellt, bis sie die Einladung annimmt.
• Der Benutzer muss bereits ein Capgo-Konto haben, bevor er eingeladen werden kann. Wenn er kein Konto hat, sollte er zunächst eines erstellen unter 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"

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

LÖSCHEN

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

Ein Mitglied aus einer Organisation entfernen. Dies wird sofort ihre Zugriffsrechte widerrufen.

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/

Erfolgsantwort

{
  "status": "OK"
}

Fehlerbehandlung

Gemeinsame 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-Erweiterung: Hinzufügen neuer Teammitglieder mit geeigneten Rollen
2. Zugriffssteuerung: Verwaltung von Mitgliederechten bei wechselnden Verantwortlichkeiten
3. Sicherheitsaudit: Überprüfen der Mitgliederliste und Rollen im Zeitablauf
4. Team-Umstrukturierung: Aktualisieren von Rollen bei organisatorischen Änderungen

Weitergehen von Mitgliedern

Wenn Sie "Mitglieder" verwenden Mitglieder um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Verschlüsselung, Compliance für die Implementierungsdetails in Compliance, Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner, Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit, und Capgo Vertrauenszentrum für den Produktworkflow im Capgo Vertrauenszentrum.