文档

AddUserGroupMember - 添加成员到用户组

更新时间:

将组织成员添加到指定的用户组。

调试

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

授权信息

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

请求参数

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

用户组 ID。

555c4cd****
UserIdListstring

Quick BI 的用户 ID,可输入多个,以英文逗号(,)分隔,例如:abc,efg。最多可输入 1000 条。

46e537a5****,3dadsu****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3
Resultboolean

返回添加用户组成员的结果。取值范围:

  • true:添加成功

  • false:添加失败

true
Successboolean

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

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "B6141A5A-A9EF-5F16-BF34-EFB9C1CCE4F3",
  "Result": true,
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.UserThe user does not exist and cannot be added to a user group.用户不存在,无法将其添加到用户组。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
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.-
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Parameter.Length.ExceedParameter length exceeds maximum limit: [%s].参数长度超过限制:%s。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
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.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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