文档

CreateGroup - 创建群组

更新时间:

创建群组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/group/create HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

group_namestring

群组名,长度 1~128 个字符

test group
descriptionstring

描述信息,长度 0~1024 个字符

test group description
is_rootboolean

是否是根群组,根群组不能加入其他任何群组,一般用于组织架构的顶层组织

false
parent_group_idstring

需要加入的父群组 ID,传入此字段时,创建完群组后,系统会将此群组自动加入到指定的父群组

2e43ec8427dd45f19431b7504649a1b3

返回参数

名称类型描述示例值
Group

新创建的群组信息

示例

正常返回示例

JSON格式

{
  "domain_id": "bj1",
  "group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
  "group_name": "test group",
  "description": "created by system",
  "created_at": 1670573504600,
  "updated_at": 1670573504600,
  "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
  "is_sync": true
}

错误码

访问错误中心查看更多错误码。