批量获取用户组成员

批量获取用户组成员

请求说明

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

请求头（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：部门成员
with_dept_info	boolean	否	是否获取部门成员信息，默认为 false
with_user_info	boolean	否	是否获取普通成员信息，默认为 false

请求地址示例

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

请求体示例

{
  "members": [
    {
      "item_ids": [
        "string"
      ],
      "item_type": "string[enum]"
    }
  ],
  "with_dept_info": false,
  "with_user_info": false
}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	用户组成员信息列表
∟ ∟ about	string	成员个性签名
∟ ∟ ctime	integer	创建时间
∟ ∟ dept_info	array[object]	部门信息
∟ ∟ ∟ abs_path	string	绝对路径
∟ ∟ ∟ id	string	部门 id
∟ ∟ ∟ name	string	部门名称
∟ ∟ group_id	string	组 id
∟ ∟ item_id	string	成员 id
∟ ∟ item_type	string[enum]	成员类型 normal：普通成员；dept：部门成员
∟ ∟ mtime	integer	更新时间
∟ ∟ nickname	string	成员昵称
∟ ∟ role	string[enum]	成员角色 normal：普通成员；admin：管理员；owner：拥有者
∟ ∟ user_info	object	用户信息
∟ ∟ ∟ avatar	string	头像
∟ ∟ ∟ depts	array[object]	部门信息
∟ ∟ ∟ ∟ abs_path	string	绝对路径
∟ ∟ ∟ ∟ id	string	部门 id
∟ ∟ ∟ ∟ id_path	string	id 路径
∟ ∟ ∟ ∟ name	string	部门名称
∟ ∟ ∟ ∟ parent_id	string	父部门 id
∟ ∟ ∟ company_id	string	企业 id
∟ ∟ ∟ id	string	用户 id，自动生成
∟ ∟ ∟ status	string[enum]	类型 normal：普通成员；dept：部门成员
∟ ∟ ∟ user_name	string	用户名称
∟ next_page_token	string	下一页的 token
∟ total	integer	数据总数
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "about": "string",
        "ctime": 0,
        "dept_info": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string"
          }
        ],
        "group_id": "string",
        "item_id": "string",
        "item_type": "string[enum]",
        "mtime": 0,
        "nickname": "string",
        "role": "string[enum]",
        "user_info": {
          "avatar": "string",
          "depts": [
            {
              "abs_path": "string",
              "id": "string",
              "id_path": "id_path",
              "name": "string",
              "parent_id": "string"
            }
          ],
          "company_id": "string",
          "id": "string",
          "status": "string[enum]",
          "user_name": "string"
        }
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string"
}