Elenca i gruppi di una directory

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

Elenca i gruppi che il provider di identità ha effettuato il provisioning nella directory, ordinati per ID: ID, ID esterno, nome visualizzato e numero di membri; mai un membro. Usa l'id di un gruppo come directory_group_id in POST /v1/directories/{directory_id}/role-mappings. Esiste solo la paginazione in avanti; il cursore è vincolato alla directory.

Richiesta

Campo	Tipo	Obbligatorio	Descrizione
`directory_id`	path	sì	ID della directory SCIM (`dir_…`).
`limit`	query	no	1–100, predefinito 20.
`after`	query	no	Il cursore di `list_metadata.after`.

Non c'è un corpo della richiesta.

Risposta

200 OK con una pagina di gruppi.

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

Errori

HTTP	code	Quando
400	`invalid_cursor`	Il cursore non è valido o appartiene a un'altra directory o filtro.
404	`not_found`	La directory non esiste in questo ambiente.
422	`validation_failed`	`limit` è fuori intervallo, oppure è stato fornito `before` o `order` (`unsupported`).
401	`unauthenticated`	La credenziale è mancante, non valida o revocata.
403	`insufficient_permissions`	La credenziale non ha l'autorizzazione richiesta.
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 questa installazione; riprova dopo il periodo `Retry-After`.

Esempio

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