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.

Mitgliederrollen

Regelmäßige Rollen

• lesen: Kann Ressourcen anzeigen, aber keine Änderungen vornehmen
• uploadKann neue Bundle hochladen und Ressourcen anzeigen
• schreiben: Ressourcen ändern und Pakete hochladen können
• admin: Organisationseinstellungen und Mitglieder verwalten können
• Superadmin: Vollzugriff auf die Organisation hat

Einladungsrollen

• Einladung_gelesen: Einladung für Leserecht ausstehend
• Einladung hochladen: Einladung für Upload-Zugriff ausstehend
• Einladung_SchreibenEinladung zum Schreiben Zugriff abzuwarten
• Einladung_AdminEinladung zum Administratorzugriff wird angenommen
• Einladung_Super_AdminEinladung für Superadmin-Zugriff steht noch aus

Gute Praxis

1. Rollenzuweisung: Zuweisen Sie Rollen, indem Sie das Prinzip der geringsten Privilegien anwenden
2. Regelmäßige Überprüfungen: Periodically review member access and remove unused accounts
3. Einbindung: Ein klares Verfahren für die Hinzufügung neuer Mitglieder und die Zuweisung von Rollen
4. Ausschreibung: Zugänglichkeiten für Mitglieder, die die Organisation verlassen, sofort entfernen

Endpunkte

POST

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

Ein neues Mitglied einer Organisation hinzufügen oder das Rollen eines bestehenden Mitglieds aktualisieren. Beachten Sie, dass Sie nur Benutzer einladen können, die bereits ein Capgo-Konto besitzen - der E-Mail-Adresse muss einer 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/

Erfolgreiche Antwort

{
  "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 akzeptieren.
• Der Benutzer muss bereits ein Capgo-Konto besitzen, bevor er eingeladen werden kann. Wenn er kein Konto besitzt, sollte er zunächst eines erstellen auf https://console.capgo.app/anmelden/

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 den Zugriff aufheben.

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

Häufige Fehler 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: Mitgliederechte verwalten bei wechselnden Verantwortlichkeiten
3. Sicherheitsprüfung: Mitgliederliste und Rollen regelmäßig überprüfen
4. Organisationsstrukturänderung: Rollen aktualisieren bei organisatorischen Änderungen

Weiter zum Mitgliedern

Wenn Sie die Mitglieder zur Planung von Sicherheit und Compliance, verbinden Sie es mit Mitglieder zur Implementierungsdetail in Verschlüsselung, Zuverlässigkeit zur Implementierungsdetail in Zuverlässigkeit, Capgo Sicherheits-Scanner zur Produktworkflow in Capgo Sicherheits-Scanner, Capgo Sicherheit zur Produktworkflow in Capgo Sicherheit, und Capgo Vertrauenszentrum zur Produktworkflow in Capgo Vertrauenszentrum.