Obtenir un groupe d'annuaire

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

Renvoie un groupe que le fournisseur d'identité a provisionné dans l'annuaire : identifiant, identifiant externe, nom d'affichage et nombre de membres ; jamais un membre. Pour lister les membres d'un groupe, utilisez GET /v1/directories/{directory_id}/users?group_id=….

Requête

Champ	Type	Obligatoire	Description
`directory_id`	path	oui	Identifiant de l'annuaire SCIM (`dir_…`).
`directory_group_id`	path	oui	Identifiant du groupe d'annuaire (`dsg_…`).

Il n'y a pas de corps de requête.

Réponse

200 OK avec le groupe.

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

Erreurs

HTTP	code	Quand
404	`not_found`	L'annuaire ou le groupe n'existe pas dans cet environnement, ou le groupe appartient à un autre annuaire.
401	`unauthenticated`	L'identifiant est absent, invalide ou révoqué.
403	`insufficient_permissions`	L'identifiant ne dispose pas de l'autorisation requise.
429	`rate_limited`	La limite de débit a été dépassée ; réessayez après la période `Retry-After`.
503	`service_unavailable`	La synchronisation des annuaires est temporairement indisponible ou non configurée dans ce déploiement ; réessayez après la période `Retry-After`.

Exemple

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