Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取用户组成员

获取用户组成员

请求说明

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

请求头(Header)

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

路径参数(Path)

名称参数类型说明
group_idstring组 id

查询参数(Query)

名称参数类型是否必填说明
item_idstring组成员 id
item_typestring[enum]组成员类型
normal:普通成员;dept:部门成员
with_dept_infoboolean是否获取部门成员信息,默认为 false
with_user_infoboolean是否获取普通成员信息,默认为 false

请求地址示例

[GET] https://openapi.wps.cn/v7/groups/{group_id}/members/read?item_id={string}&item_type={object}&with_dept_info={boolean}&with_user_info={boolean}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ aboutstring成员个性签名
∟ ctimeinteger创建时间
∟ dept_infoarray[object]部门信息
∟ ∟ abs_pathstring绝对路径
∟ ∟ idstring部门 id
∟ ∟ namestring部门名称
∟ group_idstring组 id
∟ item_idstring成员 id
∟ item_typestring[enum]成员类型
normal:普通成员;dept:部门成员
∟ mtimeinteger更新时间
∟ nicknamestring成员昵称
∟ rolestring[enum]成员角色
normal:普通成员;admin:管理员;owner:拥有者
∟ user_infoobject用户信息
∟ ∟ avatarstring头像
∟ ∟ deptsarray[object]部门信息
∟ ∟ ∟ abs_pathstring绝对路径
∟ ∟ ∟ idstring部门 id
∟ ∟ ∟ id_pathstringid 路径
∟ ∟ ∟ namestring部门名称
∟ ∟ ∟ parent_idstring父部门 id
∟ ∟ company_idstring企业 id
∟ ∟ idstring用户 id,自动生成
∟ ∟ statusstring[enum]类型
normal:普通成员;dept:部门成员
∟ ∟ user_namestring用户名称
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "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"
    }
  },
  "msg": "string"
}
回到旧版