Tenant API 端点文档

Tenant 端点

获取 Tenant

获取指定 Tenant 的详细信息。

接口地址： GET /tenant/{tenantId}

参数说明：

返回示例：

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"displayName": "My Company",
	"createdAt": "2024-01-15T10:30:00Z",
	"plan": "professional"
}

更新 Tenant

修改 Tenant 配置，如显示名称等。

接口地址： PUT /tenant/{tenantId}

参数说明：

请求 Body：

{
	"displayName": "New Company Name"
}

返回说明： 返回更新后的 Tenant 对象。

获取 Tenant 统计信息

查询指定 Tenant 的使用统计数据。

接口地址： GET /tenant/{tenantId}/statistics

参数说明：

返回示例：

{
	"processCount": 15,
	"datasetCount": 8,
	"userCount": 5,
	"storageUsedBytes": 1073741824
}

Tenant 用户端点

查询 Tenant 用户列表

获取所有有权访问该 Tenant 的用户。

接口地址： GET /tenant/{tenantId}/users

参数说明：

返回示例：

[
	{
		"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
		"email": "user@example.com",
		"firstName": "John",
		"lastName": "Doe",
		"createdAt": "2024-01-15T10:30:00Z",
		"lastLoginAt": "2024-03-01T14:00:00Z",
		"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"isActiveInTenant": true,
		"isAdminInTenant": false,
		"isDeveloperInTenant": false,
		"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
		"isActiveInOrganization": true,
		"isAdminInOrganization": false
	}
]

添加 Tenant 用户

为 Tenant 新增用户。用户不存在时会自动创建账号，存在则直接加入该 Tenant。响应返回用户 ID。

接口地址： POST /tenant/{tenantId}/users

参数说明：

请求 Body：

{
	"email": "newuser@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"isAdminInTenant": false,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}

返回示例：

{
	"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"message": "用户已添加至 Tenant。"
}

更新 Tenant 用户

修改用户在 Tenant 里的权限设置。

接口地址： PUT /tenant/{tenantId}/users

请求 Body：

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"isAdminInTenant": true,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}

返回示例：

{
	"message": "用户 Tenant 权限更新成功。"
}

移除 Tenant 用户

移除某用户对该 Tenant 的访问权限。

接口地址： DELETE /tenant/{tenantId}/users

请求 Body：

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

返回示例：

{
	"message": "用户已从 Tenant 移除。"
}