Ottieni un gruppo della directory

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

Restituisce un gruppo di cui l'identity provider ha effettuato il provisioning nella directory: ID, ID esterno, nome visualizzato e numero di membri; mai un membro. Per elencare i membri di un gruppo usa GET /v1/directories/{directory_id}/users?group_id=….

Richiesta

Campo Tipo Obbligatorio Descrizione
directory_id path sì ID della directory SCIM (dir_…).
directory_group_id path sì ID del gruppo della directory (dsg_…).

Non c'è un corpo della richiesta.

Risposta

200 OK con il gruppo.

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

Errori

HTTP code Quando
404 not_found La directory o il gruppo non esiste in questo ambiente, oppure il gruppo appartiene a un'altra directory.
401 unauthenticated La credenziale è assente, non valida o revocata.
403 insufficient_permissions La credenziale non ha il permesso richiesto.
429 rate_limited È stato superato il limite di frequenza; riprova dopo il periodo Retry-After.
503 service_unavailable La sincronizzazione delle directory è temporaneamente non disponibile o non configurata in questo deployment; riprova dopo il periodo Retry-After.

Esempio

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