所需权限

所需权限	资源	Scope	资源服务
管理员角色管理（管理）	admin-roles	admin.v1.admin-roles.manage	qwenwork-biz-service

PATCH /api/openapi/v1/admin-roles/{roleId}

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope；读取、管理与执行权限互不包含。

名称	位置	类型	必填	说明	示例
Authorization	header	string	是	应用 API Key，使用 Bearer 方式传递。	Bearer qwk_\\*
X-Request-Id	header	string	否	可选的调用追踪标识；未传入时由服务端生成。	req-20260831-001

请求参数

名称	位置	类型	必填	说明	示例
roleId	path	string · uuid	必填	需要操作的管理员角色标识。	"<uuid>"
description	body	string	否	管理员角色的用途说明。	"<string>"
member_ids	body	array \| null	必填	加入该管理员角色的用户标识列表。	["<string>"]
name	body	string	必填	管理员角色的名称。	"<string>"
permissions	body	array \| null	必填	角色授予的管理后台权限编码列表。	["<string>"]
scopes	body	array \| null	必填	此管理员角色能够管理的用户、部门和用户组范围。	[{"include_descendants":false,"subject_id":"<string>","subject_type":"<string>"}]
scopes[].include_descendants	body	boolean	否	选择部门时，是否同时包含该部门的下级部门。	false
scopes[].subject_id	body	string	必填	所选用户、部门或用户组的标识，与 subject_type 配合使用。	"<string>"
scopes[].subject_type	body	string	必填	范围对象类型：user 为用户，org_unit 为部门，user_group 为用户组。	"<string>"

请求示例

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

curl --request PATCH --url '<BASE_URL>/api/openapi/v1/admin-roles/<roleId>' --header 'Authorization: Bearer <API_KEY>' --header 'Content-Type: application/json' --data '{  "description": "<string>",  "member_ids": ["<string>"  ],  "name": "<string>",  "permissions": ["<string>"  ],  "scopes": [{"include_descendants": false,"subject_id": "<string>","subject_type": "<string>"}  ]}'

响应

200 请求成功，返回当前或更新后的数据。

名称	类型	必填	说明	示例
created_at	string · date-time	是	此记录的创建时间。	"2026-08-27T10:00:00Z"
description	string	是	管理员角色的用途说明。	"<string>"
id	string	是	此记录的唯一标识，查询、更新或删除对应记录时使用。	"<string>"
member_ids	array \| null	是	加入该管理员角色的用户标识列表。	["<string>"]
name	string	是	管理员角色的名称。	"<string>"
permissions	array \| null	是	角色授予的管理后台权限编码列表。	["<string>"]
scopes	array \| null	是	此管理员角色能够管理的用户、部门和用户组范围。	[{"include_descendants":false,"subject_id":"<string>","subject_type":"<string>"}]
scopes[].include_descendants	boolean	否	选择部门时，是否同时包含该部门的下级部门。	false
scopes[].subject_id	string	是	所选用户、部门或用户组的标识，与 subject_type 配合使用。	"<string>"
scopes[].subject_type	string	是	范围对象类型：user 为用户，org_unit 为部门，user_group 为用户组。	"<string>"
system	boolean	是	是否为系统内置角色。	false
updated_at	string · date-time	是	此记录最后一次更新的时间。	"2026-08-27T10:00:00Z"

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

default 请求失败，返回错误码和错误详情。

名称	类型	必填	说明	示例
code	string	否	用于程序判断错误原因的稳定业务错误码。	"<string>"
detail	string	是	便于阅读的错误说明。	"<string>"
details	OpenapiErrorDetails	否	字段校验失败时的详细信息。	{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.field	string	否	未通过校验的请求字段。	"<string>"
details.reason	string	否	稳定的校验失败原因，用于判断字段为何不合法。	"<string>"
details.suggestion	string	否	建议采用的规范化字段值。	"<string>"
error	string	是	稳定的 HTTP 错误类型。	"<string>"

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}