新建用户组,可以指定父用户组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:CreateUserGroup |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UserGroupId |
string |
否 |
用户组唯一 ID。
|
pop0001 |
| UserGroupName |
string |
是 |
用户组名称。
|
杭州财报 |
| UserGroupDescription |
string |
否 |
用户组描述。
|
用户分组描述 |
| ParentUserGroupId |
string |
是 |
父用户组 ID。可以将新建的用户组添加到该分组下:
|
3d2c23d4-2b41-4af8-a1f5-f6390f32**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
36829379-0C38-5BC0-830A-92665BF77D4F |
| Result |
string |
返回用户组添加成功后的 ID。如果添加失败,返回空字符串“”。 |
f5eeb52e-d9c2-4a8b-80e3-47ab55c2**** |
| Success |
boolean |
是否请求成功。取值范围:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "36829379-0C38-5BC0-830A-92665BF77D4F",
"Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Usergroup.Not.Exist | The user group does not exist. | |
| 400 | Duplicate.Name.Error | The name already exists. | |
| 400 | UserGroup.Parent.NotFound | The parent user group does not exist. | |
| 400 | Duplicate.UserGroup.Id | Duplicated usergroupId %s. | |
| 400 | RootUserGroup.Create.Error | organization %s has synchronized with other organizational structures, so user groups cannot be created under the root user group. | |
| 400 | UserGroup.Already.Synchronized | Organization has synchronized with other organizational structures, so you are not allowed to add users under group. | |
| 400 | UserGroup.Layer.Limited | The user group cannot have more than ten layers. | |
| 400 | UserGroup.ExceedsLimit.Error | User group exceed limit, %s. | |
| 400 | Duplicate.UserGroupName.Error | There is already a user group with the same name %s, please rename it before saving. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。