Elenca i blocchi di deprovisioning in blocco

GET /v1/directories/{directory_id}/deprovision-holds · autorizzazione directories:read

Elenca i blocchi di deprovisioning in blocco della directory, aperti e decisi, dal più recente: il numero di deprovisioning trattenuti, lo stato e la decisione; mai gli utenti trattenuti. Un blocco aperto viene approvato o rifiutato con POST /v1/directories/{directory_id}/deprovision-holds/{hold_id}:approve oppure :reject; dopo 72 ore viene approvato per timeout. È disponibile solo la paginazione in avanti; il cursore è legato 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 da list_metadata.after.

Non c'è un corpo della richiesta.

Risposta

200 OK con una pagina di blocchi.

{
  "data": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
      "status": "approved",
      "opened_at": "2026-10-20T09:00:00Z",
      "pending_count": 42,
      "decided_by": "api_key:key_01j9xr6s8t0v2w4x6y8z0a2b4d",
      "decided_at": "2026-10-20T10:00:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

status è open, approved o rejected. decided_by è api_key:<ID chiave>, admin_portal_link:apl_… oppure timeout; esso e decided_at sono null finché il blocco è aperto.

Errori

HTTP code Quando
400 invalid_cursor Il cursore non è valido oppure appartiene a un'altra directory.
404 not_found La directory non esiste in questo ambiente.
422 validation_failed 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/deprovision-holds?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.