创建用户组接口

创建用户组,并一次提交组内的用户和部门。部门成员可设置是否包含下级部门,服务端会检查这些成员是否落在应用获准操作的人员范围内。

所需权限

所需权限资源Scope资源服务
用户组管理(管理)user-groupsadmin.v1.user-groups.manageqwenwork-biz-service

POST /api/openapi/v1/user-groups

认证与请求头

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

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

请求参数

名称位置类型必填说明示例
Idempotency-Keyheaderstring必填本次写操作的幂等键。同一操作重试时复用相同键和请求内容,避免重复处理。"<string>"
descriptionbodystring用户组的用途说明。"<string>"
membersbodyarray | null必填用户组直接包含的用户或部门。 最多项数:1000。[{"include_descendants":false,"subject_id":"<string>","subject_type":"user"}]
members[].include_descendantsbodyboolean选择部门时,是否同时包含该部门的下级部门。false
members[].subject_idbodystring必填由 subject_type 指定的用户或部门标识。 最多字符数:255。"<string>"
members[].subject_typebodystring必填成员类型:user 为用户,org_unit 为部门。"user"
namebodystring必填用户组的名称。"<string>"

请求示例

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

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

响应

201 创建成功,返回新建的记录。

名称类型必填说明示例
created_atstring · date-time此记录的创建时间。"2026-08-27T10:00:00Z"
descriptionstring用户组的用途说明。"<string>"
idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
membersarray | null用户组直接包含的用户或部门。[{"include_descendants":false,"subject_id":"<string>","subject_type":"user"}]
members[].include_descendantsboolean选择部门时,是否同时包含该部门的下级部门。false
members[].subject_idstring由 subject_type 指定的用户或部门标识。 最多字符数:255。"<string>"
members[].subject_typestring成员类型:user 为用户,org_unit 为部门。"user"
namestring用户组的名称。"<string>"
updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
{
  "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"
}

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

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