查询用户组配置

查询用户组配置

请求说明

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

请求地址示例

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

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ link_period	integer	邀请链接有效期（单位：秒 s）
∟ share_enable	boolean	组是否允许普通成员邀请
∟ share_need_approve	boolean	邀请成员加入是否需要管理员审批
∟ visibility_members	object	可见成员，当 visibility_type 为指定可见时有此属性
∟ ∟ items	array[object]	可见成员列表
∟ ∟ ∟ avatar	string	可见成员头像
∟ ∟ ∟ ctime	integer	创建时间
∟ ∟ ∟ id	string	可见成员 id
∟ ∟ ∟ name	string	可见成员名称
∟ ∟ ∟ type	string[enum]	可见成员类型 normal：普通成员；dept：部门成员
∟ ∟ total	integer	可见成员数据总数
∟ visibility_type	string[enum]	组可见类型 nobody：不可见；all：企业成员可见；group：组成员可见；specify：指定成员可见
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "link_period": 0,
    "share_enable": false,
    "share_need_approve": false,
    "visibility_members": {
      "items": [
        {
          "avatar": "string",
          "ctime": 0,
          "id": "string",
          "name": "string",
          "type": "string[enum]"
        }
      ],
      "total": 0
    },
    "visibility_type": "string[enum]"
  },
  "msg": "string"
}