Listar retenciones de desaprovisionamiento masivo

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

Lista las retenciones de desaprovisionamiento masivo del directorio, abiertas y resueltas, de la más reciente a la más antigua: el número de desaprovisionamientos retenidos, el estado y la decisión; nunca los usuarios retenidos. Una retención abierta se aprueba o se rechaza con POST /v1/directories/{directory_id}/deprovision-holds/{hold_id}:approve o :reject; tras 72 horas se aprueba por vencimiento del plazo. Solo existe paginación hacia adelante; el cursor está vinculado al directorio.

Solicitud

Campo Tipo Obligatorio Descripción
directory_id path sí ID del directorio SCIM (dir_…).
limit query no 1–100, por defecto 20.
after query no El cursor de list_metadata.after.

No hay cuerpo de solicitud.

Respuesta

200 OK con una página de retenciones.

{
  "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 es open, approved o rejected. decided_by es api_key:<key ID>, admin_portal_link:apl_… o timeout; este campo y decided_at son null mientras la retención esté abierta.

Errores

HTTP código Cuándo
400 invalid_cursor El cursor no es válido o pertenece a otro directorio.
404 not_found El directorio no existe en este entorno.
422 validation_failed limit está fuera de rango, o se indicó before u order (unsupported).
401 unauthenticated La credencial falta, no es válida o ha sido 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 período 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 período indicado en Retry-After.

Ejemplo

curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z/deprovision-holds?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Datos personales

Este endpoint contiene datos personales: usuarios del directorio (SCIM). Datos personales en las API de KeenAuth describe qué se almacena, cuánto tiempo se conserva y cómo se elimina. No envíe categorías especiales de datos personales (salud, datos biométricos, religión, opiniones políticas, orientación sexual) en ningún campo.