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

更新用户组配置

更新用户组配置

请求说明

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

请求头(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

请求体(Body)

名称参数类型是否必填说明
link_periodinteger邀请链接有效期(单位:秒 s)
share_enableboolean组是否允许普通成员邀请
share_need_approveboolean邀请成员加入是否需要管理员审批
visibility_membersarray[object]可见成员,当 visibility_type 为指定可见时有此属性
∟ item_idsarray[string]可见成员 id 列表
∟ item_typestring[enum]可见成员类型
normal:普通成员;dept:部门成员
visibility_typestring[enum]组可见类型
nobody:不可见;all:企业成员可见;group:组成员可见;specify:指定成员可见

请求地址示例

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

请求体示例

json
{
  "link_period": 0,
  "share_enable": false,
  "share_need_approve": false,
  "visibility_members": [
    {
      "item_ids": [
        "string"
      ],
      "item_type": "string[enum]"
    }
  ],
  "visibility_type": "string[enum]"
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "string"
}
回到旧版