fca3326e34
- 更新 changelog.md: v0.2.0 记录 M2-M8 全部完成，路线图更新 - 新增 5 篇指南: RBAC、组织管理、审计日志、通知模块、质量横切 - 新增 5 篇 API 文档: RBAC(11)、Org(5)、Audit(1)、Settings(7)、Notification(7) - 更新 api/overview.md: 完整 37 端点列表 - 更新 config.ts: 侧边栏分组 + 11 页 SEO 元数据
119 lines
1.7 KiB
Markdown
119 lines
1.7 KiB
Markdown
---
|
|
title: 组织管理 API | 租户 CRUD 接口 - MengStack官方文档
|
|
---
|
|
|
|
# 组织管理接口
|
|
|
|
所有接口需要认证。
|
|
|
|
## 创建租户
|
|
|
|
**`POST /api/v1/org/tenants`**
|
|
|
|
### 请求体
|
|
|
|
```json
|
|
{
|
|
"name": "示例科技有限公司",
|
|
"slug": "example-tech"
|
|
}
|
|
```
|
|
|
|
| 字段 | 类型 | 必填 | 约束 |
|
|
|------|------|------|------|
|
|
| `name` | string | 是 | 最长 128 字符 |
|
|
| `slug` | string | 是 | 最长 64 字符，唯一 |
|
|
|
|
### 响应
|
|
|
|
```json
|
|
{
|
|
"code": 0,
|
|
"data": {
|
|
"id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"name": "示例科技有限公司",
|
|
"slug": "example-tech",
|
|
"status": 1,
|
|
"created_at": "2026-10-03T10:00:00+08:00",
|
|
"updated_at": "2026-10-03T10:00:00+08:00"
|
|
}
|
|
}
|
|
```
|
|
|
|
### 错误
|
|
|
|
| 状态码 | 说明 |
|
|
|--------|------|
|
|
| 400 | 参数校验失败 |
|
|
| 409 | slug 已存在 |
|
|
|
|
---
|
|
|
|
## 列出所有租户
|
|
|
|
**`GET /api/v1/org/tenants`**
|
|
|
|
### 响应
|
|
|
|
返回 `TenantDTO` 数组。
|
|
|
|
---
|
|
|
|
## 获取租户详情
|
|
|
|
**`GET /api/v1/org/tenants/:id`**
|
|
|
|
### 路径参数
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|------|------|------|
|
|
| `id` | string | 租户 UUID |
|
|
|
|
### 响应
|
|
|
|
返回 `TenantDTO`。
|
|
|
|
---
|
|
|
|
## 更新租户
|
|
|
|
**`PUT /api/v1/org/tenants/:id`**
|
|
|
|
### 请求体
|
|
|
|
```json
|
|
{
|
|
"name": "新名称",
|
|
"slug": "new-slug",
|
|
"status": 0
|
|
}
|
|
```
|
|
|
|
| 字段 | 类型 | 必填 | 说明 |
|
|
|------|------|------|------|
|
|
| `name` | string | 否 | 新名称 |
|
|
| `slug` | string | 否 | 新 slug |
|
|
| `status` | int | 否 | 1=启用, 0=禁用 |
|
|
|
|
---
|
|
|
|
## 删除租户
|
|
|
|
**`DELETE /api/v1/org/tenants/:id`**
|
|
|
|
### 路径参数
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|------|------|------|
|
|
| `id` | string | 租户 UUID |
|
|
|
|
### 响应
|
|
|
|
```json
|
|
{
|
|
"code": 0,
|
|
"message": "success",
|
|
"data": null
|
|
}
|
|
```
|