Verzeichnisgruppen auflisten

GET /v1/directories/{directory_id}/groups · Berechtigung directories:read

Listet die Gruppen, die der Identitätsanbieter im Verzeichnis bereitgestellt hat, sortiert nach ID: ID, externe ID, Anzeigename und Mitgliederzahl; nie ein Mitglied. Verwenden Sie die id einer Gruppe als directory_group_id in POST /v1/directories/{directory_id}/role-mappings. Es gibt nur Vorwärtspaginierung; der Cursor ist an das Verzeichnis gebunden.

Anfrage

Feld	Typ	Pflicht	Beschreibung
`directory_id`	path	ja	SCIM-Verzeichnis-ID (`dir_…`).
`limit`	query	nein	1–100, Standard 20.
`after`	query	nein	Der Cursor aus `list_metadata.after`.

Es gibt keinen Anfrage-Body.

Antwort

200 OK mit einer Seite von Gruppen.

{
  "data": [
    {
      "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
      "external_id": "00g1a2b3c4",
      "name": "Engineering",
      "member_count": 12
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

Fehler

HTTP	code	Wann
400	`invalid_cursor`	Der Cursor ist ungültig oder gehört zu einem anderen Verzeichnis oder Filter.
404	`not_found`	Das Verzeichnis existiert nicht in dieser Umgebung.
422	`validation_failed`	`limit` liegt außerhalb des Bereichs, oder `before` oder `order` wurde angegeben (`unsupported`).
401	`unauthenticated`	Die Anmeldeinformation fehlt, ist ungültig oder widerrufen.
403	`insufficient_permissions`	Der Anmeldeinformation fehlt die erforderliche Berechtigung.
429	`rate_limited`	Das Ratenlimit wurde überschritten; nach Ablauf des `Retry-After`-Zeitraums erneut versuchen.
503	`service_unavailable`	Die Verzeichnissynchronisation ist vorübergehend nicht verfügbar oder in diesem Deployment nicht konfiguriert; nach Ablauf des `Retry-After`-Zeitraums erneut versuchen.

Beispiel

curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z/groups?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"