Listar usuarios del directorio

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

Lista los registros de usuario activos que el proveedor de identidad aprovisionó en el directorio, ordenados por ID: los atributos normalizados, los grupos del directorio del usuario, el vínculo con el usuario del entorno y la marca de desviación. Los registros eliminados no se devuelven. Los filtros state y group_id pueden combinarse. Solo existe paginación hacia adelante; el cursor está vinculado al directorio y a los filtros.

Sin el permiso users:read_pii, la credencial recibe los datos personales enmascarados: user_name como su primer carácter seguido de ***, emails[].value como a***@e***.com, given_name, family_name y display_name como iniciales, y attributes como null. external_id, locale, zoneinfo, los grupos y los ID nunca se enmascaran. Una clave secreta tiene todos los permisos.

Solicitud

Campo Tipo Obligatorio Descripción
directory_id path sí ID del directorio SCIM (dir_…).
state query no Solo usuarios en este estado: active, inactive o held (en una retención de desaprovisionamiento masivo).
group_id query no Solo miembros de este grupo del directorio (dsg_…); un grupo de otro directorio devuelve una página vacía.
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 usuarios del directorio.

{
  "data": [
    {
      "id": "dsu_01j9xp4q6r8s0t2v4w6x8y0z2b",
      "directory_id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
      "external_id": "00u1a2b3c4",
      "user_name": "jane@example.com",
      "emails": [{ "value": "jane@example.com", "primary": true }],
      "given_name": "Jane",
      "family_name": "Doe",
      "display_name": "Jane Doe",
      "locale": "en-US",
      "zoneinfo": "Europe/Berlin",
      "state": "active",
      "attributes": { "department": "Engineering" },
      "groups": [{ "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a", "name": "Engineering" }],
      "user_id": "usr_01j9xq5r7s9t1v3w5x7y9z1a3c",
      "link_status": "linked",
      "drift": false,
      "created_at": "2026-10-20T09:00:00Z",
      "updated_at": "2026-10-20T09:05:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

link_status es uno de linked, invited, blocked_other_org, duplicate, mirror_only o unlinked; user_id es null cuando el registro no está vinculado. Los valores vacíos son null.

Errores

HTTP código Cuándo
400 invalid_cursor El cursor no es válido o pertenece a otro directorio o filtro.
404 not_found El directorio no existe en este entorno.
422 validation_failed state o group_id no son válidos o están repetidos, 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/users?state=active&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.