使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。
使用
适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:
无请求参数。
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
Content-Type: application/json
保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。
以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。
Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。复用 UI 环境变量服务。revision 是整份配置的版本,成功写入后重新读取最新配置;读取失败不撤销已成功的写入。最多 100 个自定义变量,key 最长 64 字符并符合标识符格式,value 最长 4096 字符。系统保留键不可作为自定义键。启用 QWENWORK_USER_SSO_TOKEN 必须显式 risk_confirmed=true。删除使用查询参数 revision。组织身份来自认证,不能由请求指定。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|---|---|---|
| 环境变量读取(read) | environment-variables | admin.v1.environment-variables.read | qwenwork-biz-service |
公共请求头
适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。
Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。
请求参数
无请求参数。
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
响应状态表
| HTTP 状态码 | 触发条件 | 响应结构引用 | 客户端处理建议 |
|---|---|---|---|
| 200 | 请求成功 | 见本文“响应结果” | 读取响应结果。 |
| default | 未单独列出的认证、授权、校验或依赖错误 | 见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构 | 按状态与 code 处理;写操作重试前核实结果及幂等要求。 |
响应结果
Content-Type: application/json
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| custom | array<object> | null | 是 | 自定义配置 | - |
| people | array<object> | null | 是 | 适用人员 | - |
| revision | integer · int64 | 是 | 当前版本号,用于并发控制; format="int64" | - |
| system | array<object> | null | 是 | 系统配置 | - |
| updated_at | string · date-time | null | 是 | 更新时间; format="date-time" | - |
custom[]
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| created_at | string · date-time | null | 是 | 创建时间; format="date-time" |
| created_by | string | null | 是 | 创建主体 ID |
| enabled | boolean | 是 | 是否启用 |
| id | string | 是 | 记录标识 |
| key | string | 是 | 环境变量名 |
| updated_at | string · date-time | null | 是 | 更新时间; format="date-time" |
| updated_by | string | null | 是 | 更新主体 ID |
| value | string | 是 | 环境变量值 |
people[]
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 邮箱 | |
| id | string | 是 | 记录标识 |
| name | string | 是 | 名称 |
system[]
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| created_at | string · date-time | null | 是 | 创建时间; format="date-time" |
| created_by | string | null | 是 | 创建主体 ID |
| enabled | boolean | 是 | 是否启用 |
| key | string | 是 | 环境变量名 |
| updated_at | string · date-time | null | 是 | 更新时间; format="date-time" |
| updated_by | string | null | 是 | 更新主体 ID |