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 ansehen, aber keine Änderungen vornehmen
• upload: Kann neue Bundles hochladen und Ressourcen ansehen
• write: Kann Ressourcen ändern und Bundles hochladen
• admin: Kann Organisationseinstellungen und Mitglieder verwalten
• super_admin: Hat volle Kontrolle über die Organisation

Einladungsrollen

• Einladungen lesenErmittlung von Best Practices
• Ermittlung von Best PracticesErmittlung von Upload-Zugriffsanfragen
• Ermittlung von SchreibzugriffsanfragenErmittlung von Administrationszugriffsanfragen
• Ermittlung von Super-Admin-ZugriffsanfragenBest Practices
• Zuweisung von Rollen: __CAPGO_KEEP_0__

invite_upload

1. invite_write: Folge dem Grundsatz der geringsten Rechte, wenn Rollen zuweisen
2. Regelmäßige Audits: Überprüfe regelmäßig den Zugriff der Mitglieder und entferne nicht genutzte Konten
3. Einbringung: Habe einen klaren Prozess für die Aufnahme neuer Mitglieder und die Zuweisung von Rollen
4. Austritt: Entferne den Zugriff für Mitglieder, die die Organisation verlassen, schnell

Endpunkte

POST

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

Ein neues Mitglied einer Organisation hinzufügen oder das Rollen eines bestehenden Mitglieds aktualisieren. Beachte, dass du nur Benutzer einladen kannst, die bereits ein Capgo-Konto haben – 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.
• The Benutzer muss bereits ein Capgo Konto haben, bevor sie eingeladen werden können. Wenn sie kein Konto haben, sollten sie 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"
    }
  ]
}

DELETE

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

Ein Mitglied aus einer Organisation entfernen. Dies wird sofort ihren Zugriff entziehen.

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

Häufige 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"
}

Häufige Verwendungsfälle

1. Team-Erweiterung: Neue Teammitglieder mit geeigneten Rollen hinzufügen
2. Zugriffssteuerung: Mitgliederrechte bei verändernden Verantwortlichkeiten verwalten
3. Sicherheitsaudit: Mitgliederliste und Rollen regelmäßig überprüfen
4. Teamumstrukturierung: Rollen bei organisatorischen Veränderungen aktualisieren

Fortsetzung von Mitgliedern

: Wenn Sie Capgo verwenden Mitglieder um Sicherheit und Compliance zu planen und 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 in Capgo Vertrauenszentrum.