Elenca gli utenti della directory

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

Elenca i record utente attivi che il provider di identità ha sottoposto a provisioning nella directory, ordinati per ID: gli attributi normalizzati, i gruppi della directory dell'utente, il collegamento all'utente dell'ambiente e il flag di drift. I record eliminati non vengono restituiti. I filtri state e group_id possono essere combinati. È disponibile solo la paginazione in avanti; il cursore è legato alla directory e ai filtri.

Senza l'autorizzazione users:read_pii la credenziale riceve i dati personali mascherati: user_name come primo carattere seguito da ***, emails[].value come a***@e***.com, given_name, family_name e display_name come iniziali, e attributes come null. external_id, locale, zoneinfo, i gruppi e gli ID non vengono mai mascherati. Una chiave segreta ha tutte le autorizzazioni.

Richiesta

Campo Tipo Obbligatorio Descrizione
directory_id path sì ID della directory SCIM (dir_…).
state query no Solo gli utenti in questo stato: active, inactive oppure held (in un blocco di deprovisioning in blocco).
group_id query no Solo i membri di questo gruppo della directory (dsg_…); un gruppo di un'altra directory restituisce una pagina vuota.
limit query no 1–100, predefinito 20.
after query no Il cursore da list_metadata.after.

Non c'è un corpo della richiesta.

Risposta

200 OK con una pagina di utenti della directory.

{
  "data": [
    {
      "id": "dsu_01j9xp4q6r8s0t2v4w6x8y0z2b",
      "directory_id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
      "external_id": "00u1a2b3c4",
      "user_name": "jane@example.com",
      "emails": [{ "value": "jane@example.com", "primary": true }],
      "given_name": "Jane",
      "family_name": "Doe",
      "display_name": "Jane Doe",
      "locale": "en-US",
      "zoneinfo": "Europe/Berlin",
      "state": "active",
      "attributes": { "department": "Engineering" },
      "groups": [{ "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a", "name": "Engineering" }],
      "user_id": "usr_01j9xq5r7s9t1v3w5x7y9z1a3c",
      "link_status": "linked",
      "drift": false,
      "created_at": "2026-10-20T09:00:00Z",
      "updated_at": "2026-10-20T09:05:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

link_status è uno tra linked, invited, blocked_other_org, duplicate, mirror_only o unlinked; user_id è null quando il record non è collegato. I valori vuoti sono null.

Errori

HTTP code Quando
400 invalid_cursor Il cursore non è valido oppure appartiene a un'altra directory o a un altro filtro.
404 not_found La directory non esiste in questo ambiente.
422 validation_failed state o group_id non è valido o è ripetuto, limit è fuori intervallo, oppure è stato passato before o order (unsupported).
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo indicato in Retry-After.
503 service_unavailable La sincronizzazione della directory è temporaneamente non disponibile o non configurata in questo deployment; riprova dopo il periodo indicato in Retry-After.

Esempio

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

Dati personali

Questo endpoint contiene dati personali: utenti della directory (SCIM). Dati personali nelle API di KeenAuth descrive cosa viene memorizzato, per quanto tempo viene conservato e come viene cancellato. Non inviare categorie particolari di dati personali (salute, dati biometrici, religione, opinioni politiche, orientamento sessuale) in nessun campo.