Groups Endpoints

Die Groups API bietet Endpoints zur Verwaltung von Sicherheits- und Verteilergruppen und deren Mitgliedschaft.

Basis-URL

Alle Endpoints sind relativ zu /api/v1/groups.

---

Gruppen auflisten

Ruft eine paginierte Liste von Gruppen ab.

GET /api/v1/groups

Query-Parameter

Parameter	Typ	Beschreibung
search	string	Nach Gruppenname suchen
limit	number	Anzahl der zurückzugebenden Elemente
after	string	Cursor für Paginierung

Antwort

{
  "groups": [
    {
      "id": "grp-123",
      "name": "Engineering Team",
      "description": "All engineering staff",
      "group_type": "security",
      "is_privileged": false,
      "member_count": 45,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "cursor-token"
  }
}

---

Gruppe abrufen

Ruft Details für eine bestimmte Gruppe ab.

GET /api/v1/groups/{id}

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Gruppen-ID

Antwort

Gibt das vollständige Gruppenobjekt mit allen Feldern zurück.

---

Gruppe erstellen

Erstellt einen neuen Gruppendatensatz.

POST /api/v1/groups

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Request Body

{
  "name": "Finance Team",
  "description": "Finance department members",
  "group_type": "security",
  "is_privileged": false
}

Antwort

Gibt das erstellte Gruppenobjekt zurück.

---

Gruppe aktualisieren

Aktualisiert eine bestehende Gruppe.

PUT /api/v1/groups/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Gruppen-ID

Request Body

Nur die zu aktualisierenden Felder einschließen.

Antwort

Gibt das aktualisierte Gruppenobjekt zurück.

---

Gruppe löschen

Löscht einen Gruppendatensatz.

DELETE /api/v1/groups/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Gruppen-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

Gruppenmitglieder abrufen

Ruft alle Mitglieder einer Gruppe mit erweiterten Details ab.

GET /api/v1/groups/{id}/members

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Gruppen-ID

Antwort

{
  "members": [
    {
      "id": "acc-123",
      "name": "john.doe",
      "email": "john.doe@company.com",
      "membership_type": "direct",
      "added_date": "2024-01-10T00:00:00Z",
      "status": "active"
    }
  ],
  "count": 45
}

Mitgliedschaftstypen

Typ	Beschreibung
direct	Mitglied direkt zur Gruppe hinzugefügt
indirect	Mitglied über verschachtelte Gruppe geerbt

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Parameter
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
404	Not Found - Gruppe existiert nicht
500	Internal Server Error

---

Verwandte Themen

• Accounts API - Kontoverwaltungs-Endpoints
• API Reference - Vollständiger API-Index