企业管理与企业集成 API
企业版(!lite 构建)独有的管理、合规与集成端点:租户/用户/审计/配额/离职/GDPR、企业授权激活、卫星服务代理、企业 IM Webhook、OIDC 单点登录。
版本说明:本页全部端点均为
[企业](个人版不注册这些路由)。企业版管理路由统一挂在租户中间件链上:JWT 鉴权 → 安全管线 → 租户解析 → 审计 → RLS → CostGuard;admin子组额外要求管理员权限(RequireAdmin)。
租户管理(/api/v1/tenants,RequireAdmin)
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /api/v1/tenants | 创建租户 |
GET | /api/v1/tenants | 租户列表 |
GET | /api/v1/tenants/:id | 租户详情 |
GET / PUT | /api/v1/tenants/:id/config | 读取 / 更新租户配置 |
GET / POST | /api/v1/tenants/:id/departments | 部门列表 / 创建部门 |
GET | /api/v1/tenants/:id/departments/:deptId/members | 部门成员 |
DELETE | /api/v1/tenants/:id | 删除租户 |
用户管理(/api/v1/admin/users,RequireAdmin)
| 方法 | 路径 | 说明 |
|---|---|---|
POST / GET | /api/v1/admin/users | 创建 / 列出用户 |
GET / PUT / DELETE | /api/v1/admin/users/:id | 查看 / 更新 / 删除用户 |
PUT | /api/v1/admin/users/:id/password | 重置密码 |
PUT | /api/v1/admin/users/:id/role | 变更角色 |
GET / POST | /api/v1/admin/users/:id/api-keys | 查看 / 创建用户 API Key |
DELETE | /api/v1/admin/users/:id/api-keys/:keyId | 删除 API Key |
DELETE | /api/v1/admin/users/:id/gdpr | GDPR 删除用户 |
运维与审计(RequireAdmin)
| 方法 | 路径 | 说明 |
|---|---|---|
GET / PUT | /api/v1/admin/log/level | 查询 / 设置运行时日志级别 |
GET | /api/v1/admin/config/reload | 手动触发配置热重载 |
GET | /api/v1/admin/audit/events | 审计事件查询 |
GET | /api/v1/admin/audit/compliance | 合规报告 |
POST | /api/v1/admin/audit/export | 审计日志导出 |
重要事实:
/api/v1/admin/audit/*额外挂RequireFeature("audit_log")特性门控——audit_log是 Enterprise 计费方案特性,Free / Pro 方案调用会被拒绝。
仪表盘(/api/v1/admin/dashboard)
| 方法 | 路径 | 说明 |
|---|---|---|
GET | /api/v1/admin/dashboard/stats | 总览统计 |
GET | /api/v1/admin/dashboard/usage | 用量趋势 |
GET | /api/v1/admin/dashboard/agents/status | Agent 状态 |
GET | /api/v1/admin/dashboard/audit/summary | 审计摘要 |
GET | /api/v1/admin/dashboard/billing/summary | 计费摘要 |
配额与计费(RequireAdmin)
| 方法 | 路径 | 说明 |
|---|---|---|
GET | /api/v1/admin/quotas | 租户配额查询 |
PUT | /api/v1/admin/quotas/:tenantID | 更新租户配额 |
GET | /api/v1/admin/quotas/:tenantID/departments | 部门配额列表 |
PUT | /api/v1/admin/quotas/:tenantID/departments/:deptID | 更新部门配额 |
POST | /api/v1/admin/quotas/reset | 重置租户配额 |
企业版计费组(/api/v1/billing,RequireAdmin)比 计费 API 页面的基础端点多两个:GET /api/v1/billing/plans(计费方案列表)与 GET /api/v1/billing/overage(超额用量)。
员工离职(/api/v1/offboarding,RequireAdmin)
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /api/v1/offboarding/:id/lock / unlock | 锁定 / 解锁用户 |
POST | /api/v1/offboarding/:id/transfer | 资产转移 |
GET | /api/v1/offboarding/:id/assets | 资产清单 |
POST | /api/v1/offboarding/:id/export | 导出用户数据 |
DELETE | /api/v1/offboarding/:id | 删除用户 |
GDPR(/api/v1/gdpr,登录用户)
| 方法 | 路径 | 说明 |
|---|---|---|
GET / DELETE | /api/v1/gdpr/data | 请求数据 / 执行擦除 |
POST | /api/v1/gdpr/export | 数据可携(导出) |
GET / POST | /api/v1/gdpr/consent | 查询 / 记录同意 |
GET | /api/v1/gdpr/consent/:id | 同意记录详情 |
企业授权激活(/api/v1/activation)
| 方法 | 路径 | 鉴权 | 说明 |
|---|---|---|---|
POST | /api/v1/activation/activate | 公开 | 激活本机企业授权 |
GET | /api/v1/activation/status | 公开 | 查询企业授权状态 |
POST | /api/v1/activation/deactivate | 需登录 | 停用本机企业授权(破坏性操作) |
版本说明:企业版仅保留以上 3 个授权激活端点(
activate/status/deactivate)。activate与status保持公开——设备首次激活时没有凭据,挂认证会打死激活流程;deactivate为破坏性操作故强制认证。个人版的本地授权面完全不同(register/transfer等恒 404),不要混用两端文档。
卫星服务代理(/api/v1/store、/api/v1/translate、/api/v1/email)
卫星商店/翻译/邮件是独立 Python 服务,企业版通过反向代理转发(SATELLITE_* 环境变量配置上游)。
| 方法 | 路径 | 说明 |
|---|---|---|
GET / POST | /api/v1/store/*path | 卫星商店转发 |
POST | /api/v1/translate | 卫星翻译转发 |
POST | /api/v1/email/send / search | 卫星邮件发送 / 搜索 |
GET | /api/v1/email/read / status | 卫星邮件读取 / 状态 |
⚠️ 卫星 URL 未配置 →
503;上游不可达 →502;转发超时 10s。卫星 URL 当前从环境变量硬编码加载(与 Hub satellites 表未连通,后续版本计划改为启动时动态拉取)。
企业 IM Webhook(公开,IM 平台推送)
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /api/v1/webhook/feishu | 飞书事件订阅 |
POST | /api/v1/webhook/dingtalk | 钉钉机器人回调 |
POST | /api/v1/webhook/wecom | 企业微信回调 |
OIDC 单点登录(企业版独有)
| 方法 | 路径 | 说明 |
|---|---|---|
GET | /api/v1/auth/oidc/login | 跳转 OIDC 提供方(公开) |
GET | /api/v1/auth/oidc/callback | OIDC 回调(公开) |
可观测与规约
| 方法 | 路径 | 说明 |
|---|---|---|
GET | /metrics | Prometheus 指标(公开) |
GET | /api/v1/openapi.yaml | OpenAPI 规约文件(公开) |
GET | /api/v1/health | 健康检查(含 MCP 工具计数) |
企业版 V4 路由差异
企业版 V4 组(/api/v4 与 /api/v1/v4 双前缀)相对个人版的差异:
- scheduler 走 Temporal 引擎,并额外提供
PATCH /scheduler/:id/pause、PATCH /scheduler/:id/resume、POST /scheduler/:id/execute-now、PATCH /scheduler/:id、GET /scheduler/:id/executions(执行历史);POST /schedule/create是scheduler/create的别名。 - LLM 模型 CRUD:
POST /llm/models、PUT /llm/models/:name、DELETE /llm/models/:name(另有toggle)。 - 浏览器端点两人齐全:
snapshot/cast/self-test与screenshot/read/act(见 桌面/浏览器 API)。 GET /profile/ai为 stub(返回tier/ai_credits/model占位,待 Hub 接入)。- PoC 实验路由(
/api/poc/*)需LYNCORE_ENABLE_POC=true才挂载。
错误码
| 场景 | code | 说明 |
|---|---|---|
| 未认证 | 40100 | 缺失或非法/已吊销令牌 |
| 非管理员调用 admin 端点 | 40300 | RequireAdmin 拒绝 |
| 计费方案不含 audit_log | 40300 | RequireFeature 门控拒绝 |
| 卫星上游未配置 | 503(HTTP) | 卫星 URL 缺失 |
| 卫星上游不可达 | 502(HTTP) | 转发失败/超时 |