创建用户组
创建用户组
请求说明
请求地址 | https://openapi.wps.cn/v7/groups/create |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理用户组(应用授权) kso.group.readwrite 查询和管理用户组(用户授权) kso.group.readwrite |
请求头(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} |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
creator_id | string | 是 | 创建者 id |
dept_id | string | 否 | 关联部门,仅部门组才有此属性 |
description | string | 否 | 描述介绍 |
name | string | 是 | 名称 |
owner_id | string | 否 | 拥有者 id,企业组只能是本企业成员,个人组只能是自己 |
source | string | 否 | 用户组的引用业务方,默认为 default |
type | string[enum] | 否 | 类型 normal :普通用户组;dept :部门用户组;org_dynamic :企业动态用户组;org_normal :企业静态用户组 |
visibility_members | array[object] | 否 | 可见成员,当 visibility_type 为指定可见时有此属性 |
∟ item_ids | array[string] | 否 | 可见成员 id 列表 |
∟ item_type | string[enum] | 否 | 可见成员类型 normal :普通成员;dept :部门成员 |
visibility_type | string[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]"
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ avatar | string | 头像 |
∟ company_id | string | 组织 id |
∟ creator_id | string | 创建者 id 创建时即确定,不被修改 |
∟ ctime | integer | 创建时间 |
∟ dept_id | string | 关联部门 id,默认 0 |
∟ description | string | 描述介绍 |
∟ id | string | 组 id |
∟ member_total | integer | 成员数量 |
∟ mtime | integer | 更新时间 |
∟ name | string | 名称 |
∟ owner_id | string | 拥有者 id |
∟ source | string | 用户组的引用业务方 |
∟ status | string[enum] | 状态 enable :正常;recycled :回收站 |
∟ type | string[enum] | 类型 normal :普通用户组;dept :部门用户组;org_dynamic :企业动态用户组;org_normal :企业静态用户组 |
more | object | 更多的错误信息 |
响应体示例
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"
}