Mitglieder

Organization members are users who have access to your Capgo organization. Each member has a specific role that determines their permissions within the organization. Managing members effectively is crucial for maintaining security and collaboration in your team.

Abschnitt mit dem Titel „Mitgliederrollen“

protectedTokens

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

Einladungsrollen

• invite_read: Wartende Einladung für die Leserechtigkeit
• invite_upload: Wartende Einladung für das Hochladen
• invite_write: Wartende Einladung für die Schreibrechte
• invite_admin: Wartende Einladung für die Administratorrechte
• invite_super_admin: Wartende Einladung für die Super-Administratorrechte

Gute Praktiken

1. Rollenzuweisung: Führen Sie die Grundsätze der geringsten Privilegien bei der Zuweisung von Rollen aus
2. Regelmäßige Audits: Überprüfen Sie regelmäßig den Zugriff von Mitgliedern und entfernen Sie nicht genutzte Konten
3. Einbindung: Haben Sie einen klaren Prozess für die Hinzufügung neuer Mitglieder und die Zuweisung von Rollen
4. Ausschreibung: Entfernen Sie den Zugriff für Mitglieder, die die Organisation verlassen

Abschnitte

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 er die Einladung annimmt.
• Der Benutzer muss bereits ein Capgo-Konto haben, bevor er eingeladen werden kann. Wenn er kein Konto hat, sollte er zuerst eines erstellen 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"

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/

Erfolgreiche Antwort

{
  "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 veränderlichen 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 die Sicherheit und die Einhaltung von Vorschriften zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Verschlüsselung, Einhaltung für die Implementierungsdetails in Einhaltung, 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.