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
• : Kann neue Pakete hochladen und Ressourcen anzeigen: Kann neue Pakete hochladen und Ressourcen anzeigen
• upload: Ressourcen können modifiziert und Bundel hochgeladen werden
• admin: Organisationseinstellungen und Mitglieder können verwaltet werden
• super_admin: Die Organisation vollständig kontrollieren

Einladungsrollen

• : Einladung für Leserecht steht noch aus: Einladung für Upload-Zugriff steht noch aus
• : Einladung für Schreibzugriff steht noch aus__CAPGO_KEEP_0__
• __CAPGO_KEEP_0__: Einladung für die Schreibzugriffserweiterung wartet noch
• invite_admin: Einladung für den Administrator-Zugriff wartet noch
• invite_super_admin: Einladung für den Super-Administrator-Zugriff wartet noch

Best Practices

1. Role Assignment: Zuschreiben von Rollen, wobei die Grundsätze der geringsten Privilegien angewendet werden
2. Regular Audits: Regelmäßige Überprüfung der Mitgliedszugriffe und Entfernen von nicht benötigten 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, schnellstmöglich

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 besitzen - der E-Mail-Adresse muss einer 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, erhält er eine Einladungsemail. Seine Rolle wird mit „invite_“ vorangestellt, bis er 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"
    }
  ]
}

DELETE

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

Ein Mitglied aus einer Organisation entfernen. Dies wird sofort ihren Zugriff 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: Neue Teammitglieder mit entsprechenden Rollen hinzufügen
2. Zugriffssteuerung: Mitgliederechte als Verantwortlichkeiten ändern
3. Sicherheitsaudit: Mitgliederliste und Rollen regelmäßig überprüfen
4. Teamumstrukturierung: Rollen während organisatorischer Änderungen aktualisieren

Weitermachen von Mitgliedern

Wenn Sie " Mitglieder " zur Planung von Sicherheit und Compliance verwenden, verbinden Sie es mit " Verschlüsselung " für die Implementierungsdetails in Verschlüsselung, Kontrollverletzungen für die Implementierungsdetails in Kontrollverletzungen, 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 in Capgo Vertrauenszentrum.