Organization
最后更新:2026年6月22日
Organization 是承载多个 Space 的顶层容器。一家公司或一个团队对应一个 Organization,其下可以放置多个 Space。订阅套餐(plan)和成员关系在 Organization 层级管理,因此计费和成员权限都以该 Organization 为基准应用,而不是以 Space 为基准。
可以通过 GET /me/organization-memberships 查询当前用户所属的 Organization 列表。该资源没有返回全部列表的端点。
资源结构
下面是 Organization「DailyWear 公司」单条查询的响应。它包含 sys(系统属性)以及正文属性 name 和 description。
{
"sys": {
"id": "ilLRJxDp",
"type": "Organization",
"createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"createdAt": "2026-05-11T10:51:16.832Z",
"updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"updatedAt": "2026-05-11T10:51:16.832Z",
"version": 1,
"isOfficial": false,
"plan": { "sys": { "id": "free", "type": "Refer", "targetType": "Plan" } }
},
"name": "DailyWear 公司",
"description": "运营服装、杂货在线商城的公司"
}主要键:
name:Organization 的名称(1-64 个字符)。即公司或团队的显示名称。description:对 Organization 的说明(1-128 个字符,可选)。plan:指向该 Organization 订阅套餐的Refer<Plan>(例如free)。计费套餐绑定在此处。isOfficial:是否为官方 Organization(boolean)。
系统属性(sys)与正文
每个 Organization 都把通用系统属性放在 sys 对象中。createdBy 和 updatedBy 以 Refer 形态({ "sys": { "id", "type": "Refer", "targetType" } })进入,plan 则是 Refer<Plan>。
| 属性 | 类型 | 说明 |
|---|---|---|
id | string | 资源唯一标识符。 |
type | string | 资源种类。Organization 始终为 "Organization"。 |
createdBy | Refer<User> | 创建该资源的用户。 |
createdAt | string (date-time) | 创建时间。 |
updatedBy | Refer<User> | 最后修改该资源的用户。 |
updatedAt | string (date-time) | 最后修改时间。 |
version | integer (≥1) | 资源版本。每次修改递增 1。 |
isOfficial | boolean | 是否为官方 Organization。 |
plan | Refer<Plan> | 订阅套餐。例如 free。 |
正文属性:
| 属性 | 类型 | 说明 |
|---|---|---|
name | string (1-64) | Organization 名称。在创建和修改时指定。 |
description | string (1-128) | Organization 说明。为可选项。 |
icon | string(读取)/ object(写入) | Organization 图标。在响应中为图片 URL 字符串。在修改请求中,以指向已上传文件的对象 { "upload": { "sys": { ..., "targetType": "Upload" } } } 发送(引用通过 Upload API 获取的 Upload)。 |
Organization 是没有发布概念的配置类资源。因此与 Content、Media 不同,它的 sys 中没有 publish、archive、status,只有 version。每次修改 Organization 时 version 都会递增。
API
以下所有端点的基准 URL 均为 https://cma.weegloo.com/v1,并且 Authorization 头需要携带用于认证 CMA 的 Bearer 令牌。修改和部分修改需要同时发送用于乐观并发控制的 X-Weegloo-Version 头(当前资源的 sys.version)。创建和删除不需要此头。
相关文档
- Space:该 Organization 下的 Space。
- Organization Membership:查询 Organization 成员以及当前用户所属的组织。
