文档

CreateUserGroup - 新建用户组

更新时间:

新建用户组,可以指定父用户组。

调试

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

授权信息

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

请求参数

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

用户组唯一 ID。

  • 无需传入,系统会自动生成;当用户主动传入 UserGroupId 时,以用户传入的 ID 作为用户组 ID,用户需要自行保证该 ID 在组织内唯一。
  • 格式校验:最大长度 64,不能为-1,
pop0001
UserGroupNamestring

用户组名称。

  • 格式校验:最大长度 255
  • 特殊格式校验:中英文数字 _ \ / | () ] [
杭州财报
UserGroupDescriptionstring

用户组描述。

  • 格式校验:最大长度 255
  • 特殊格式校验:中英文数字 _ \ / | () ] [
用户分组描述
ParentUserGroupIdstring

父用户组 ID。可以将新建的用户组添加到该分组下:

  • 当输入父用户组 ID 时,新建的用户组会添加到该 ID 的用户组下。
  • 当输入-1 时,新建的用户组会添加到根目录下。
3d2c23d4-2b41-4af8-a1f5-f6390f32****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

36829379-0C38-5BC0-830A-92665BF77D4F
Resultstring

返回用户组添加成功后的 ID。如果添加失败,返回空字符串“”。

f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "36829379-0C38-5BC0-830A-92665BF77D4F",
  "Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
400Duplicate.Name.ErrorThe name already exists.命名重复。
400UserGroup.Parent.NotFoundThe parent user group does not exist.父用户组不存在。
400Duplicate.UserGroup.IdDuplicated usergroupId %s.重复的用户组ID %s。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。

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

变更历史

变更时间变更内容概要操作
2023-06-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-05-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (0)
文档反馈