将用户批量添加到指定的用户组中。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:AddUserGroupMembers |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UserId |
string |
是 |
Quick BI 的用户 ID。 |
46e5****37a5 |
| UserGroupIds |
string |
是 |
用户组 ID,以英文逗号分隔。示例:aGroupId,bGroupId,cGroupIds |
0d5fb19b-****-****-99da-1248fc27ca51 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
D8749D65-E80A-433C-AF1B-CE9C180FF3B4 |
| Result |
boolean |
接口执行结果。取值范围:
|
true |
| Success |
boolean |
是否请求成功。取值范围:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": true,
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Invalid.User | The user does not exist and cannot be added to a user group. | 用户不存在,无法将其添加到用户组。 |
| 400 | Usergroup.Not.Exist | The user group does not exist. | 用户组不存在。 |
| 400 | Invalid.Parameter | The length of the parameter must not exceed 1000. | |
| 400 | UserGroup.Already.Synchronized | Organization has synchronized with other organizational structures, so you are not allowed to add users under group. | 该组织已经同步过其他组织架构,因此无法在根用户组下新增用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。