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

创建用户组

创建用户组

请求说明

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

请求体(Body)

名称参数类型是否必填说明
creator_idstring创建者 id
dept_idstring关联部门,仅部门组才有此属性
descriptionstring描述介绍
namestring名称
owner_idstring拥有者 id,企业组只能是本企业成员,个人组只能是自己
sourcestring用户组的引用业务方,默认为 default
typestring[enum]类型
normal:普通用户组;dept:部门用户组;org_dynamic:企业动态用户组;org_normal:企业静态用户组
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/create

请求体示例

json
{
  "creator_id": "string",
  "dept_id": "string",
  "description": "string",
  "name": "string",
  "owner_id": "string",
  "source": "string",
  "type": "string[enum]",
  "visibility_members": [
    {
      "item_ids": [
        "string"
      ],
      "item_type": "string[enum]"
    }
  ],
  "visibility_type": "string[enum]"
}

响应体

名称参数类型说明
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"
}
回到旧版