本页内容

> 资源 > 文档 > api > API参考：组织

API参考：组织

warning

删除环境会永久移除其中的所有流程、数据集和用户分配。此操作无法撤销。您不能删除用于身份验证的环境。

warning

将用户从组织中移除后，该用户将无法访问组织内的任何环境。

组织可将多个环境归入同一实体。

获取环境所属的组织

可使用租户范围的API密钥读取；也接受组织范围的密钥。

端点： GET /v1/tenant/{tenantId}/organization

**身份验证：**租户或组织范围的API密钥 · read范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`

响应（200）：

组织详情

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

字段	类型	必填	说明
id	string	是	格式：`uuid`
displayName	string	是	默认值：`""` 最大长度：128
createdAt	string	是	格式：`date-time`
contactEmail	string	是	格式：`email`
isActive	boolean	是	默认值：`true`
allowedLogins	object	是
createdBy	string	是	格式：`uuid`

错误：

401缺少、无效、已禁用或已过期的API密钥
404未找到资源

获取组织席位容量和自动同步策略

返回组织范围内各席位等级（流程基础、流程架构、流程智能）的已购买和已使用席位数、免费查看者额度、自动同步目标、席位差异说明（系统将执行的操作及其时间）、计费周期和externalApiSeatPolicy。可使用租户范围的API密钥读取。路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： GET /v1/tenant/{tenantId}/organization/billing/seats

**身份验证：**租户或组织范围的API密钥 · read范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`

响应（200）：

席位容量

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

字段	类型	必填	说明
contractType	`free` \| `selfServe` \| `fixed` \| `unlimited`	是	允许的值：`free`、`selfServe`、`fixed`、`unlimited`
isTrial	boolean	是
purchased	object	是
inUseBillable	object	是
inUseFree	number	是
inUseDashboardViewers	number	是
totalBillable	number	是
freeViewerAllowance	number	是
freeViewerOverAllowance	number	是
dashboardViewerAllowance	number	是
dashboardViewerOverAllowance	number	是
fixedOverage	number	是
target	object	是
drift	object[]	是
interval	`month` \| `year`	是	允许的值：`month`、`year`
nextBilledAt	string	是
externalApiSeatPolicy	`autoBill` \| `requireCapacity`	是	允许的值：`autoBill`、`requireCapacity`

错误：

401缺少、无效、已禁用或已过期的API密钥
404未找到资源

获取组织统计数据

路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： GET /v1/tenant/{tenantId}/organization/statistics

**身份验证：**组织范围的API密钥 · read范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`

响应（200）：

组织统计

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

字段	类型	必填
userCount	number	是
tenantCount	number	是
tenantStatistics	object[]	是

错误：

401缺少、无效、已禁用或已过期的API密钥

列出组织中的所有环境

路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： GET /v1/tenant/{tenantId}/organization/tenants

**身份验证：**组织范围的API密钥 · read范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
limit	integer	查询参数	否	返回项目的最大数量
offset	integer	查询参数	否	跳过的项目数量

响应（200）：

环境列表

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

错误：

401缺少、无效、已禁用或已过期的API密钥

在组织中创建环境（需要组织范围的API密钥）

路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： POST /v1/tenant/{tenantId}/organization/tenants

**身份验证：**组织范围的API密钥 · write范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`

请求正文：

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

字段	类型	必填	说明
displayName	string	否	最大长度：128
shortName	string	是
description	string	否	最大长度：200
timezone	string	否	最大长度：64
tenantType	`normal` \| `sandbox` \| `demo`	否	允许的值：`normal`、`sandbox`、`demo`

响应（201）：

环境已创建

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

字段	类型	必填	说明
id	string	是	格式：`uuid`
createdBy	string	是	格式：`uuid`
createdAt	string	是	格式：`date-time`
displayName	string	是	默认值：`""` 最大长度：128
contactEmail	string	是	格式：`email`
isActive	boolean	是	默认值：`true`
shortName	string	是
useOrganizationTheme	boolean	是	默认值：`true`
description	string	是	最大长度：200
organizationId	string	是	格式：`uuid`
allowedLogins	object	是
tenantType	`normal` \| `sandbox` \| `demo`	是	允许的值：`normal`、`sandbox`、`demo` 默认值：`normal`
url	string	是	格式：`uri`

错误：

400请求错误，例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401缺少、无效、已禁用或已过期的API密钥
403API密钥缺少所需范围或组织访问权限、租户未激活，或套餐不支持该文件类型
406无法接受该值（例如名称为保留名称或重复名称）

软删除组织中的环境（需要组织范围的API密钥）

该环境的API访问权限会立即停止。在删除安全期内，环境及其数据会保留；之后将由自动彻底删除流程移除。无法删除您当前使用的环境（上下文环境）。

端点： DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

**身份验证：**组织范围的API密钥 · write范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
targetId	string	路径	是	格式：`uuid`

响应（200）：

环境已删除

{
	"success": true,
	"message": "string"
}

字段	类型	必填	说明
success	boolean	是
message	string	是

错误：

400请求错误，例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401缺少、无效、已禁用或已过期的API密钥
403API密钥缺少所需范围或组织访问权限、租户未激活，或套餐不支持该文件类型
404未找到资源

恢复组织中软删除的环境（需要组织范围的API密钥）

在删除安全期内撤销软删除：环境及其数据会原样恢复，API访问权限也会重新启用。路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

**身份验证：**组织范围的API密钥 · write范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
targetId	string	路径	是	格式：`uuid`

响应（200）：

环境已恢复

{
	"success": true,
	"message": "string"
}

字段	类型	必填	说明
success	boolean	是
message	string	是

错误：

400请求错误，例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401缺少、无效、已禁用或已过期的API密钥
403API密钥缺少所需范围或组织访问权限、租户未激活，或套餐不支持该文件类型
404未找到资源

列出组织中的所有用户

路径参数{tenantId}表示上下文环境（即组织范围密钥所属组织中的环境），而非操作目标。

端点： GET /v1/tenant/{tenantId}/organization/users

**身份验证：**组织范围的API密钥 · read范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
limit	integer	查询参数	否	返回项目的最大数量
offset	integer	查询参数	否	跳过的项目数量

响应（200）：

组织用户列表

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

错误：

401缺少、无效、已停用或已过期的API密钥

更新组织用户设置（需要组织范围的API密钥）

请求正文中的角色标志（isAdminInOrganization、isActiveInOrganization）将按原值生效；仅向组织管理员发放组织范围的密钥。路径参数{tenantId}表示上下文环境（即组织范围密钥所属的组织），而非操作目标。

端点： PUT /v1/tenant/{tenantId}/organization/users/{userId}

**身份验证：**组织范围的API密钥 · write范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
userId	string	路径	是	格式：`uuid`

请求正文：

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

字段	类型	必填	说明
isActiveInOrganization	boolean	否	用户是否在组织中处于活跃状态
isAdminInOrganization	boolean	否	组织管理员权限（按原值生效：仅向组织管理员发放组织范围的密钥）

响应（200）：

已更新

{
	"message": "string"
}

字段	类型	必填	说明
message	string	是

错误：

401缺少、无效、已停用或已过期的API密钥
403API密钥缺少所需范围或组织访问权限、环境未激活，或套餐不支持该文件类型
404未找到资源

从组织中移除用户（需要组织范围的API密钥）

路径参数{tenantId}表示上下文环境（即组织范围密钥所属的组织），而非操作目标。

端点： DELETE /v1/tenant/{tenantId}/organization/users/{userId}

**身份验证：**组织范围的API密钥 · write范围

参数：

名称	类型	位置	必填	说明
tenantId	string	路径	是	格式：`uuid`
userId	string	路径	是	格式：`uuid`

响应（200）：

已移除用户

{
	"message": "string"
}

字段	类型	必填	说明
message	string	是

错误：

401缺少、无效、已停用或已过期的API密钥
403API密钥缺少所需范围或组织访问权限、环境未激活，或套餐不支持该文件类型
404未找到资源

优化流程，构建互联架构，掌控全局。

无需信用卡，也无需等待，即刻开始。将组织的实际工作方式转化为清晰、互联的流程设计。

构建流程架构，明确职责归属与管控措施，并在各层级统一角色分工。

开始免费试用，为流程治理、管理和持续改进建立可靠的统一基础。

立即开始免费试用

API参考：组织

获取环境所属的组织

获取组织席位容量和自动同步策略

获取组织统计数据

列出组织中的所有环境

在组织中创建环境（需要组织范围的API密钥）

软删除组织中的环境（需要组织范围的API密钥）

恢复组织中软删除的环境（需要组织范围的API密钥）

列出组织中的所有用户

更新组织用户设置（需要组织范围的API密钥）

从组织中移除用户（需要组织范围的API密钥）

相关文档

API参考：租户

API参考：数据

API参考：流程

API参考：模拟

优化流程，构建互联架构，掌控全局。