创建用户组
适用版本>=v7.0.2412a.20241212
接口说明:创建用户组
请求说明
| 请求地址 | 配置域名+/openapi+/v7/groups/create |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理用户组(应用授权) 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)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 名称 |
| string | 否 | 邮箱 | |
| description | string | 否 | 描述介绍 |
| source | string | 否 | 用户组的引用业务方,默认为default,目前仅支持default |
| visibility_members | object[] | 否 | 可见成员,当visibility_type为指定可见时有此属性 |
| ∟ item_ids | string[] | 否 | 可见成员IDs |
| ∟ item_type | string | 否 | 可见成员类型,可选值:normal:普通成员;dept:部门成员 |
| visibility_type | string | 否 | 可见类型,默认为企业成员可见。可选值:nobody:不可见;all:企业成员可见;group:组成员可见;specify:指定成员可见 |
请求体示例
json
{
"description": "string",
"name": "string",
"mail": "string",
"source": "default",
"visibility_members": [
{
"item_ids": ["string"],
"item_type": "normal"
}
],
"visibility_type": "all"
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 用户组信息 |
| ∟ avatar | string | 头像 |
| ∟ company_id | string | 企业ID |
| ∟ creator_id | string | 创建者ID 创建时即确定,不被修改。 |
| ∟ ctime | int64 | 创建时间 |
| ∟ dept_id | string | 关联部门ID, 默认 0 |
| ∟ description | string | 描述介绍 |
| ∟ id | string | 组ID |
| ∟ member_total | string | 成员数量 |
| ∟ mtime | int64 | 更新时间 |
| ∟ name | string | 名称 |
| string | 邮箱 | |
| ∟ owner_id | string | 拥有者ID |
| ∟ source | string | 创建用户组的业务方来源 |
| ∟ status | string | 状态,enable:正常;recycled:回收站;deleted:删除; |
| ∟ type | string | 状态,normal:普通用户组;dept:部门用户组;whole:全员用户组; |
响应体示例
json
{
"data": {
"avatar": "string",
"company_id": "string",
"creator_id": "string",
"ctime": 1,
"dept_id": "string",
"description": "string",
"id": "string",
"member_total": 0,
"mtime": 1,
"name": "string",
"mail": "string",
"owner_id": "string",
"source": "string",
"status": "enable",
"type": "normal"
},
"code": 0,
"detail": "string",
"msg": "string"
}