Skip to main content

创建用户组接口

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

  • Scope：admin.v1.user-groups.manage
  • 权限项：用户组管理（user-groups）
  • 权限类型：管理
  • 接口：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必填用户组成员-
namebodystring必填用户组名称"<string>"

members[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
include_descendantsboolean否部门对象是否包含下级部门
subject_idstring是适用对象 ID
subject_typestring是适用对象类型；可选值：user, org_unit

请求示例

curl --request POST \
  --url 'https://example.invalid/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

名称类型必填说明示例
created_atstring · date-time是创建时间"2026-08-27T10:00:00Z"
descriptionstring是说明"<string>"
idstring是用户组 ID"<string>"
membersarray ｜ null是用户组成员-
namestring是用户组名称"<string>"
updated_atstring · date-time是更新时间"2026-08-27T10:00:00Z"

members[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
include_descendantsboolean否部门对象是否包含下级部门
subject_idstring是适用对象 ID
subject_typestring是适用对象类型；可选值：user, org_unit
{
  "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 Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}