Obtener un directorio

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

Devuelve un directorio SCIM con su retención de desaprovisionamiento masivo abierta (null si no hay ninguna). Una retención se abre cuando una sincronización desaprovisionaría demasiados usuarios a la vez; apruébela o recházela con los endpoints deprovision-holds. Los metadatos de los tokens se listan con GET /v1/directories/{directory_id}/tokens.

Solicitud

Campo Tipo Obligatorio Descripción
directory_id ruta sí ID del directorio SCIM (dir_…).

No hay cuerpo de solicitud.

Respuesta

200 OK con el directorio y su ETag (el valor de If-Match para 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
  }
}

Errores

HTTP code Cuándo
404 not_found El directorio no existe en este entorno.
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 "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"