本页内容

API参考：租户

获取租户信息

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

**身份验证：**租户范围的API密钥 · read权限范围

参数：

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

响应（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"
}

字段	类型	必填	说明
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`

错误：

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

更新租户设置

端点： PUT /v1/tenant/{tenantId}

**身份验证：**租户范围的API密钥 · write权限范围

参数：

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

请求正文：

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

字段	类型	必填	说明
id	string	否	格式：`uuid`
displayName	string	否
contactEmail	string	否
shortName	string	否
description	string	否

响应（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"
}

字段	类型	必填	说明
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无法接受该值（例如名称为保留字或与现有名称重复）

获取租户统计信息（数据大小、模型、模拟、用户）

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

**身份验证：**租户范围的API密钥 · read权限范围

参数：

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

响应（200）：

租户统计信息

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

字段	类型	必填	说明
tenantId	string	是	格式：`uuid`
uploadedDataSize	number	是
uploadedDataCount	number	是
modelCount	number	是
simulationCount	number	是
userCount	number	是

错误：

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

列出租户中的用户

以普通JSON数组形式返回匹配的用户，不包含总数；使用limit/offset进行分页。

端点： GET /v1/tenant/{tenantId}/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",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

错误：

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

向租户添加用户（不会发送邀请邮件）

请求正文中的角色字段（isAdminInTenant、access: none|portalViewer|designer|architect|intelligence、isDashboardViewer）将按原值处理；此端点提供完整的租户管理员权限，因此仅向可信调用方发放具有写入权限的密钥。仪表板查看权限由布尔值isDashboardViewer控制；旧版只读查看者级别已移除。

端点： POST /v1/tenant/{tenantId}/users

**身份验证：**租户范围的API密钥 · write权限范围

参数：

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

请求正文：

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

字段	类型	必填	说明
email	string	是	用户的电子邮件地址（也是登录身份）格式：`email`
firstName	string	否	可选的名字最大长度：64
lastName	string	否	可选的姓最大长度：64
isActiveInTenant	boolean	否	用户在此环境中是否处于活跃状态
isAdminInTenant	boolean	否	用户在此环境中的管理员权限（按原值生效：完整的环境管理员权限范围）
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	否	单选席位：none \| portalViewer \| designer \| architect \| intelligence 允许的值：`none`、`portalViewer`、`designer`、`architect`、`intelligence`
isDashboardViewer	boolean	否	用户是否拥有仪表板只读权限
preferredLocale	`en` \| `zh` \| `es` \| `fr` \| `de` \| `pt` \| `it` \| `nl` \| `ja` \| `tr` \| `pl` \| `cs` \| `hu` \| `id` \| `ko` \| `vi` \| `th`	否	用户偏好的界面语言允许的值：`en`、`zh`、`es`、`fr`、`de`、`pt`、`it`、`nl`、`ja`、`tr`、`pl`、`cs`、`hu`、`id`、`ko`、`vi`、`th`

响应（201）：

用户已添加

{
	"id": "string",
	"message": "string"
}

字段	类型	必填	说明
id	string	是	新添加用户的ID
message	string	是

错误：

401 API密钥缺失、无效、已停用或已过期
409 请求与当前状态冲突（例如席位限制或重复使用ID）

更新用户的环境设置

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

**身份验证：**环境级API密钥 · write权限范围

参数：

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

请求正文：

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

字段	类型	必填	说明
isActiveInTenant	boolean	否	用户在此环境中是否处于活跃状态
isAdminInTenant	boolean	否	用户在此环境中的管理员权限（按原样生效：拥有完整的环境管理员权限）
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	否	单选席位：none \| portalViewer \| designer \| architect \| intelligence。仪表板查看权限由isDashboardViewer布尔值控制。允许的值：`none`、`portalViewer`、`designer`、`architect`、`intelligence`
isDashboardViewer	boolean	否	用户是否拥有仪表板只读权限

响应（200）：

已更新

{
	"message": "string"
}

字段	类型	必填	说明
message	string	是

错误：

400 请求错误：例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401 API密钥缺失、无效、已停用或已过期
404 未找到资源

从环境中移除用户

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

**身份验证：**环境级API密钥 · write权限范围

参数：

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

响应（200）：

用户已移除

{
	"message": "string"
}

字段	类型	必填	说明
message	string	是

错误：

400 请求错误：例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401 API密钥缺失、无效、已停用或已过期
404 未找到资源

为用户生成一次性登录交接令牌

返回一个与用户、环境和组织绑定的单次使用令牌（有效期60秒），以及用于将用户浏览器跳转至url的URL。在用户的浏览器中打开该URL后，用户即可通过身份验证进入ProcessMind：无需电子邮件链接，也无需模拟用户身份；用户将获得自己的会话。API密钥必须具有专用的sessions权限范围：具有组织级权限的密钥可为该组织中的任意环境生成令牌；具有环境级权限的密钥只能为其所属环境中的用户生成令牌。请将此令牌视同密码妥善保管：令牌仅返回一次，不会写入日志；停用密钥或用户即可撤销令牌。

端点： POST /v1/tenant/{tenantId}/users/{userId}/login-token

**身份验证：**环境级或组织级API密钥 · sessions权限范围 · 速率限制为每秒2个请求（突发上限4个）

参数：

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

请求正文：

可选的目标路径（相对于应用的路径，例如“app”或“app/dashboards”）

{
	"path": "string"
}

字段	类型	必填	说明
path	string	否	最大长度：512

响应（200）：

登录交接令牌

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

字段	类型	必填	说明
token	string	是
url	string	是
expiresInSeconds	number	是
expiresAt	string	是	格式：`date-time`

错误：

400 请求错误：例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401 API密钥缺失、无效、已停用或已过期
403 API密钥缺少所需权限范围或组织访问权限、环境未启用，或套餐不支持该文件类型
404 未找到资源
429 请求过于频繁：请参阅端点文档中的速率限制

API密钥用于验证集成身份。组织级密钥可为组织中的任意环境创建和管理密钥。

列出环境的API密钥

需要使用组织级API密钥。不会返回密钥的秘密值。

端点： GET /v1/tenant/{tenantId}/api-keys

**身份验证：**组织级API密钥 · read权限范围

参数：

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

响应（200）：

API密钥列表

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

错误：

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

创建环境级API密钥

需要使用组织级写入密钥。密钥的秘密值由服务器生成，并在响应中仅返回一次，请妥善保存。系统只保留其哈希值。

端点： POST /v1/tenant/{tenantId}/api-keys

**身份验证：**组织级API密钥 · write权限范围

参数：

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

请求正文：

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

字段	类型	必填	说明
displayName	string	是	最大长度：128
scope	object	否
enabled	boolean	否
expiresAt	string	否	格式：`date-time`

响应（201）：

API密钥已创建（包含一次性秘密值）

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

字段	类型	必填	说明
id	string	是	格式：`uuid`
tenantId	string	是	格式：`uuid`
organizationId	string	是	格式：`uuid`
displayName	string	是	最大长度：128
partialKey	string	是	最大长度：128
enabled	boolean	是	默认值：`true`
createdAt	string	是	格式：`date-time`
lastUsedAt	string	是	格式：`date-time`
expiresAt	string	是	格式：`date-time`
scope	object	是
secret	string	是	最大长度：128

错误：

400 请求错误：例如筛选表达式无效、流程没有模型、上传类型不受支持或缺少必填字段
401 API密钥缺失、无效、已停用或已过期
403 API密钥缺少所需权限范围或组织访问权限、环境未启用，或套餐不支持该文件类型

更新环境级API密钥

需要使用组织级写入密钥。权限范围字段会与已保存的权限范围合并。

端点： PUT /v1/tenant/{tenantId}/api-keys/{keyId}

**身份验证：**组织级API密钥 · write权限范围

参数：

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

请求正文：

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

字段	类型	必填	说明
displayName	string	否	最大长度：128
scope	object	否
enabled	boolean	否
expiresAt	string	否	格式：`date-time`

响应（200）：

API密钥已更新

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

字段	类型	必填	说明
id	string	是	格式：`uuid`
tenantId	string	是	格式：`uuid`
organizationId	string	是	格式：`uuid`
displayName	string	是	最大长度：128
partialKey	string	是	最大长度：128
enabled	boolean	是	默认值：`true`
createdAt	string	是	格式：`date-time`
lastUsedAt	string	是	格式：`date-time`
expiresAt	string	是	格式：`date-time`
scope	object	是

错误：

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

删除环境级API密钥

需要使用组织级写入密钥。密钥将被软删除，并立即停止用于身份验证。

端点： DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

**身份验证：**组织级API密钥 · write权限范围

参数：

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

响应（200）：

API密钥已删除

{
	"message": "string"
}

字段	类型	必填	说明
message	string	是

错误：

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

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

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

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

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

立即开始免费试用

API参考：租户

获取租户信息

更新租户设置

获取租户统计信息（数据大小、模型、模拟、用户）

列出租户中的用户

向租户添加用户（不会发送邀请邮件）

更新用户的环境设置

从环境中移除用户

为用户生成一次性登录交接令牌

列出环境的API密钥

创建环境级API密钥

更新环境级API密钥

删除环境级API密钥

相关文档

API参考：组织

API参考：数据

API参考：流程

API参考：模拟

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