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

添加用户组成员

添加用户组成员

请求说明

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

路径参数(Path)

名称参数类型说明
group_idstring组 id

请求体(Body)

名称参数类型是否必填说明
aboutstring组成员个性签名
item_idstring组成员 id
item_typestring[enum]组成员类型
normal:普通成员;dept:部门成员
nicknamestring组成员昵称
rolestring[enum]组成员角色
normal:普通成员;admin:管理员;owner:拥有者

请求地址示例

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

请求体示例

json
{
  "about": "string",
  "item_id": "string",
  "item_type": "string[enum]",
  "nickname": "string",
  "role": "string[enum]"
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ group_idstring组 id
∟ item_idstring成员 id
∟ item_typestring[enum]成员类型
normal:普通成员;dept:部门成员
∟ rolestring[enum]成员角色
normal:普通成员;admin:管理员;owner:拥有者
∟ aboutstring成员个性签名
∟ nicknamestring成员昵称
∟ dept_infoarray[object]部门信息
∟ ∟ abs_pathstring绝对路径
∟ ∟ idstring部门 id
∟ ∟ namestring部门名称
∟ 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用户名称
∟ ctimeinteger创建时间
∟ mtimeinteger更新时间
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "group_id": "string",
    "item_id": "string",
    "item_type": "string[enum]",
    "role": "string[enum]",
    "about": "string",
    "nickname": "string",
    "dept_info": [
      {
        "abs_path": "string",
        "id": "string",
        "name": "string"
      }
    ],
    "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"
    },
    "ctime": 0,
    "mtime": 0
  },
  "msg": "string"
}
回到旧版