Eine Verzeichnisgruppe abrufen

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

Gibt eine Gruppe zurück, die der Identity Provider im Verzeichnis bereitgestellt hat: ID, externe ID, Anzeigename und Anzahl der Mitglieder; niemals ein Mitglied. Um die Mitglieder einer Gruppe aufzulisten, verwenden Sie GET /v1/directories/{directory_id}/users?group_id=….

Anfrage

Feld	Typ	Pflicht	Beschreibung
`directory_id`	Pfad	ja	SCIM-Verzeichnis-ID (`dir_…`).
`directory_group_id`	Pfad	ja	Verzeichnisgruppen-ID (`dsg_…`).

Es gibt keinen Anfragetext.

Antwort

200 OK mit der Gruppe.

{
  "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
  "external_id": "00g1a2b3c4",
  "name": "Engineering",
  "member_count": 12
}

Fehler

HTTP	code	Wann
404	`not_found`	Das Verzeichnis oder die Gruppe existiert in dieser Umgebung nicht, oder die Gruppe gehört zu einem anderen Verzeichnis.
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 dem Zeitraum `Retry-After` erneut versuchen.
503	`service_unavailable`	Die Verzeichnissynchronisation ist vorübergehend nicht verfügbar oder in dieser Bereitstellung nicht konfiguriert; nach dem Zeitraum `Retry-After` erneut versuchen.

Beispiel

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