Disattivare una directory

POST /v1/directories/{directory_id}:deactivate · autorizzazione directories:write

Disattiva la directory (state diventa inactive). I suoi token restano validi, ma la directory risponde a ogni richiesta SCIM con lo stesso 401 di un token non valido, e una directory mai usata non si attiva più alla prima richiesta. Utenti e gruppi già sincronizzati vengono conservati. Per annullare, usa POST /v1/directories/{directory_id}:activate. L'operazione è idempotente: se la directory è già disattivata non viene scritto nulla, la versione resta invariata e la directory viene restituita con 200. La scrittura viene registrata nell'audit come directory.deactivated.

Richiesta

Campo Tipo Obbligatorio Descrizione
directory_id percorso sì ID della directory SCIM (dir_…).
Idempotency-Key header no Ripropone la prima risposta per una richiesta ritentata.

Il corpo è facoltativo e non ha campi ({}). If-Match non viene usato.

Risposta

200 OK con la directory e il suo ETag.

{
  "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": ["title", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:department"],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 20, "absolute_min": 25},
  "send_welcome_email": false
}

Errori

HTTP code Quando
400 unknown_field Il corpo contiene un campo.
404 not_found La directory non esiste in questo ambiente.
409 conflict La directory è in eliminazione.
422 idempotency_key_reuse Idempotency-Key è stato usato per una richiesta diversa.
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 -X POST "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z:deactivate" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"