更新用户组接口

更新时间:
复制 MD 格式

所需权限

所需权限

资源

Scope

资源服务

用户组管理(管理)

user-groups

admin.v1.user-groups.manage

qwenwork-biz-service

PATCH /api/openapi/v1/user-groups/{groupId}

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。

Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

请求体:必填;Content-Type:application/json。

名称

位置

类型

必填

说明

示例

groupId

path

string · uuid

是

用户组 ID

"<uuid>"

description

body

string

否

说明

"<string>"

members

body

array<object> | null

是

用户组成员 maxItems=1000

-

name

body

string

是

用户组名称

"<string>"

body.members[] 字段

字段

类型

必填

说明

include_descendants

boolean

否

部门对象是否包含下级部门

subject_id

string

是

适用对象 ID maxLength=255

subject_type

string

是

适用对象类型;可选值:user, org_unit 取值:"org_unit"、"user"

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request PATCH \
  --url '<BASE_URL>/api/openapi/v1/user-groups/<groupId>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "members": [
    {
      "include_descendants": false,
      "subject_id": "<string>",
      "subject_type": "user"
    }
  ],
  "name": "<string>"
}'

响应状态表

HTTP 状态码

触发条件

响应结构引用

客户端处理建议

200

请求成功

见本文“响应结果”

读取响应结果。

default

未单独列出的认证、授权、校验或依赖错误

见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构

按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json

名称

类型

必填

说明

示例

created_at

string · date-time

是

创建时间

"2026-08-27T10:00:00Z"

description

string

是

说明

"<string>"

id

string

是

用户组 ID

"<string>"

members

array<object> | null

是

用户组成员

-

name

string

是

用户组名称

"<string>"

updated_at

string · date-time

是

更新时间

"2026-08-27T10:00:00Z"

members[]

字段

类型

必填

说明

include_descendants

boolean

否

部门对象是否包含下级部门

subject_id

string

是

适用对象 ID maxLength=255

subject_type

string

是

适用对象类型;可选值:user, org_unit 取值:"org_unit"、"user"

响应示例

{
  "created_at": "2026-08-27T10:00:00Z",
  "description": "<string>",
  "id": "<string>",
  "members": [
    {
      "include_descendants": false,
      "subject_id": "<string>",
      "subject_type": "user"
    }
  ],
  "name": "<string>",
  "updated_at": "2026-08-27T10:00:00Z"
}