Skip to content

创建用户组

适用版本>=v7.0.2412a.20241212

接口说明:创建用户组

请求说明

请求地址配置域名+/openapi+/v7/groups/create
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理用户组(应用授权) 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)

名称类型是否必填说明
namestring名称
mailstring邮箱
descriptionstring描述介绍
sourcestring用户组的引用业务方,默认为default,目前仅支持default
visibility_membersobject[]可见成员,当visibility_type为指定可见时有此属性
item_idsstring[]可见成员IDs
item_typestring可见成员类型,可选值:normal:普通成员;dept:部门成员
visibility_typestring可见类型,默认为企业成员可见。可选值:
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)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject用户组信息
avatarstring头像
company_idstring企业ID
creator_idstring创建者ID 创建时即确定,不被修改。
ctimeint64创建时间
dept_idstring关联部门ID, 默认 0
descriptionstring描述介绍
idstring组ID
member_totalstring成员数量
mtimeint64更新时间
namestring名称
mailstring邮箱
owner_idstring拥有者ID
sourcestring创建用户组的业务方来源
statusstring状态,enable:正常;recycled:回收站;deleted:删除;
typestring状态,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"
}