Recuperare una directory

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

Restituisce una directory SCIM con la sua sospensione di deprovisioning di massa aperta (null se non ce n'è). Una sospensione si apre quando una sincronizzazione deprovisionerebbe troppi utenti in una volta; approvala o rifiutala con gli endpoint deprovision-holds. I metadati dei token sono elencati da GET /v1/directories/{directory_id}/tokens.

Richiesta

Campo Tipo Obbligatorio Descrizione
directory_id percorso sì ID della directory SCIM (dir_…).

Non c'è un corpo della richiesta.

Risposta

200 OK con la directory e il suo ETag (il valore If-Match per PATCH /v1/directories/{directory_id}).

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta",
  "state": "inactive",
  "base_url": "https://acme.eu.keenauth.app/scim/v2/dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "created_at": "2026-10-19T09:31:00.123456Z",
  "last_request_at": null,
  "provisioning_mode": "user_store",
  "attribute_allowlist": [],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 10, "absolute_min": 25},
  "send_welcome_email": false,
  "open_deprovision_hold": {
    "id": "0192a3c0-1d2e-7f3a-8b4c-5d6e7f8a9b0c",
    "opened_at": "2026-10-19T10:02:00Z",
    "pending_count": 42
  }
}

Errori

HTTP code Quando
404 not_found La directory non esiste in questo ambiente.
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha il permesso richiesto.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo indicato da Retry-After.
503 service_unavailable La sincronizzazione delle directory è temporaneamente non disponibile o non configurata in questo deployment; riprova dopo il periodo indicato da Retry-After.

Esempio

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