Desactivar un directorio
POST /v1/directories/{directory_id}:deactivate · permiso directories:write
Desactiva el directorio (state pasa a inactive). Sus tokens siguen siendo válidos, pero el directorio responde a cada solicitud SCIM con el mismo 401 que un token no válido, y un directorio que nunca se usó ya no se activa con su primera solicitud. Los usuarios y grupos ya sincronizados se conservan. Para deshacerlo, use POST /v1/directories/{directory_id}:activate. La operación es idempotente: si el directorio ya está desactivado no se escribe nada, la versión se mantiene y el directorio se devuelve con 200. La escritura se audita como directory.deactivated.
Solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
directory_id |
ruta | sí | ID del directorio SCIM (dir_…). |
Idempotency-Key |
encabezado | no | Reproduce la primera respuesta para una solicitud reintentada. |
El cuerpo es opcional y no tiene campos ({}). If-Match no se usa.
Respuesta
200 OK con el directorio y su 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
}
Errores
| HTTP | code | Cuándo |
|---|---|---|
| 400 | unknown_field |
El cuerpo contiene un campo. |
| 404 | not_found |
El directorio no existe en este entorno. |
| 409 | conflict |
El directorio se está eliminando. |
| 422 | idempotency_key_reuse |
Idempotency-Key se usó para una solicitud distinta. |
| 401 | unauthenticated |
La credencial falta, no es válida o fue revocada. |
| 403 | insufficient_permissions |
La credencial no tiene el permiso requerido. |
| 429 | rate_limited |
Se superó el límite de frecuencia; reintente después del tiempo indicado en Retry-After. |
| 503 | service_unavailable |
La sincronización de directorios no está disponible temporalmente o no está configurada en este despliegue; reintente después del tiempo indicado en Retry-After. |
Ejemplo
curl -i -X POST "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z:deactivate" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"