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

获取用户组

获取用户组

请求说明

请求地址https://openapi.wps.cn/v7/groups/{group_id}
请求方法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)

名称参数类型是否必填说明
with_member_totalboolean是否返回 member_total 成员数量,默认 false 不返回

请求地址示例

[GET] https://openapi.wps.cn/v7/groups/{group_id}?with_member_total={boolean}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ avatarstring头像
∟ company_idstring组织 id
∟ creator_idstring创建者 id 创建时即确定,不被修改
∟ ctimeinteger创建时间
∟ dept_idstring关联部门 id,默认 0
∟ descriptionstring描述介绍
∟ idstring组 id
∟ member_totalinteger成员数量
∟ mtimeinteger更新时间
∟ namestring名称
∟ owner_idstring拥有者 id
∟ sourcestring用户组的引用业务方
∟ statusstring[enum]状态
enable:正常;recycled:回收站
∟ typestring[enum]类型
normal:普通用户组;dept:部门用户组;org_dynamic:企业动态用户组;org_normal:企业静态用户组
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "avatar": "string",
    "company_id": "string",
    "creator_id": "string",
    "ctime": 0,
    "dept_id": "string",
    "description": "string",
    "id": "string",
    "member_total": 0,
    "mtime": 0,
    "name": "string",
    "owner_id": "string",
    "source": "string",
    "status": "string[enum]",
    "type": "string[enum]"
  },
  "msg": "string"
}
回到旧版