Mitglieder

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

Mitgliederrollen

Regelmäßige Rollen

• lesen: Kann Ressourcen anzeigen, aber keine Änderungen vornehmen
• upload: Kann neue Bundles hochladen und Ressourcen anzeigen
• write: Kann Ressourcen bearbeiten und Bundles hochladen
• admin: Kann Organisationseinstellungen und Mitglieder verwalten
• super_admin: Hat volle Kontrolle über die Organisation

Einladungsrollen

• invite_read: Wartende Einladung für Leserecht
• invite_uploadEinladung zum Upload warten
• invite_writeEinladung zum Schreiben warten
• invite_adminEinladung zum Administrator warten
• invite_super_adminEinladung zum Super-Administrator warten

Best Practices

1. Role AssignmentBerechtigungszuweisung: Verwenden Sie das Konzept der geringsten Privilegien, wenn Sie Rollen zuweisen
2. Regelmäßige Audits: Regelmäßig überprüfen Sie den Zugriff der Mitglieder 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. Austritt: Entfernen Sie den Zugriff für Mitglieder, die die Organisation verlassen haben

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/

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. https://console.capgo.app/deutsch/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/

Anforderungskörper

Abschnitt mit dem Titel „Anforderungskörper“

interface MemberDelete {
  orgId: string
  email: string
}

protectedTokens

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: Neue Teammitglieder mit geeigneten Rollen hinzufügen
2. Zugriffssteuerung: Mitgliederrechte anhand von Verantwortlichkeiten verwalten
3. Sicherheitsaudit: Mitgliederliste und Rollen regelmäßig überprüfen
4. Teamumstrukturierung: Rollen bei organisatorischen Änderungen aktualisieren

Fortsetzung von Mitgliedern

Wenn Sie Members um Sicherheit und Compliance zu planen, verbinden Sie es mit Verschlüsselung für die Implementierungsdetails in Verschlüsselung Kongruenz für die Implementierungsdetails in Kongruenz Capgo Sicherheits-Scanner für den Produktworkflow in Capgo Sicherheits-Scanner Capgo Sicherheit für den Produktworkflow in Capgo Sicherheit und Capgo Trust Center für den Produktworkflow in Capgo Trust Center.