Listar grupos del directorio

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

Lista los grupos que el proveedor de identidad aprovisionó en el directorio, ordenados por ID: ID, ID externo, nombre para mostrar y número de miembros; nunca un miembro. Use el id de un grupo como directory_group_id en POST /v1/directories/{directory_id}/role-mappings. 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, valor predeterminado 20.
after query no El cursor de list_metadata.after.

No hay cuerpo de solicitud.

Respuesta

200 OK con una página de grupos.

{
  "data": [
    {
      "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a",
      "external_id": "00g1a2b3c4",
      "name": "Engineering",
      "member_count": 12
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

Errores

HTTP code 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 limit está fuera de rango, o se envió before u order (unsupported).
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 tras el periodo Retry-After.
503 service_unavailable La sincronización de directorios no está disponible temporalmente o no está configurada en este despliegue; reintente tras el periodo Retry-After.

Ejemplo

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