批量添加用户组成员

批量添加用户组成员

请求说明

请求地址	https://openapi.wps.cn/v7/groups/{group_id}/members/batch_create
请求方法	POST
签名方式	KSO-1
权限要求	查询和管理用户组（应用授权） kso.group.readwrite 查询和管理用户组（用户授权） kso.group.readwrite

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

路径参数（Path）

名称	参数类型	说明
group_id	string	组 id

请求体（Body）

名称	参数类型	是否必填	说明
members	array[object]	是	成员信息
∟ item_ids	array[string]	是	组成员 id 列表
∟ item_type	string[enum]	否	组成员类型 normal：普通成员；dept：部门成员
∟ role	string[enum]	否	组成员角色 normal：普通成员；admin：管理员；owner：拥有者
with_success_and_failure_list	boolean	否	是否返回添加结果 默认为 false，不返回；当为 true 时，允许部分成员添加失败，并返回失败列表

请求地址示例

[POST] https://openapi.wps.cn/v7/groups/{group_id}/members/batch_create

请求体示例

{
  "members": [
    {
      "item_ids": [
        "string"
      ],
      "item_type": "string[enum]",
      "role": "string[enum]"
    }
  ],
  "with_success_and_failure_list": false
}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ add_dept_count	integer	成功添加的部门成员数量
∟ add_user_count	integer	成功添加的普通成员数量
∟ failure_list	array[object]	添加失败的成员列表
∟ ∟ item_id	string	组成员 id
∟ ∟ item_name	string	组成员名
∟ ∟ item_type	string[enum]	组成员类型 normal：普通成员；dept：部门成员
∟ ∟ result	string	结果
∟ success_list	array[object]	添加成功的成员列表
∟ ∟ item_id	string	组成员 id
∟ ∟ item_name	string	组成员名
∟ ∟ item_type	string[enum]	组成员类型 normal：普通成员；dept：部门成员
∟ ∟ result	string	结果
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "add_dept_count": 0,
    "add_user_count": 0,
    "failure_list": [
      {
        "item_id": "string",
        "item_name": "string",
        "item_type": "string[enum]",
        "result": "string"
      }
    ],
    "success_list": [
      {
        "item_id": "string",
        "item_name": "string",
        "item_type": "string[enum]",
        "result": "string"
      }
    ]
  },
  "msg": "string"
}