本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。
添加组织成员。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:AddUser |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
AdminUser
deprecated
|
boolean |
否 |
是否赋予组织管理员角色。取值范围:
重要 参数已过期不推荐使用,当传入 RoleIds 时该参数无效。 |
true |
AuthAdminUser
deprecated
|
boolean |
否 |
是否赋予组织权限管理员角色。取值范围:
重要 参数已过期不推荐使用,当传入 RoleIds 时该参数无效。 |
true |
| UserType |
integer |
是 |
组织成员的用户类型。取值范围:
|
1 |
| AccountId |
string |
否 |
阿里云账号 ID。 警告 Quick BI 于 2024 年 12 月 31 日之后发布的版本,AccountId 将作为必填参数,请在此之前,对您的 API 进行改造。 |
191476xxxxx23754 |
AccountName
deprecated
|
string |
否 |
阿里云账号名称。
|
xxxxxx@163.com |
| NickName |
string |
是 |
阿里云账号昵称。
|
张三 |
| RoleIds |
string |
否 |
用户绑定的预置或自定义组织角色 ID,用英文逗号“,”分割,最多 3 个。取值范围:
|
111111111,456 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
D787E1A3-A93C-424A-B626-C2B05DF8D885 |
| Result |
object |
返回新增阿里云用户的详细信息。 |
|
| AccountName |
string |
阿里云账户。 |
xxxxxx@163.com |
| AdminUser |
boolean |
是否绑定了组织管理员角色。取值范围:
重要 参数已过期不推荐使用,当传入 RoleIdList 时该参数无效 |
true |
| AuthAdminUser |
boolean |
是否绑定了权限管理员角色。取值范围:
重要 参数已过期不推荐使用,当传入 RoleIdList 时该参数无效 |
true |
| NickName |
string |
阿里云账号昵称。 |
张三 |
| RoleIdList |
array |
用户绑定的组织角色 ID 列表。 |
|
|
integer |
组织角色 ID,最多 3 个,包括但不限于组织预置角色:
|
111111111 |
|
| UserId |
string |
Quick BI 中的 UserID。 |
b5d8fd9348cc4327****afb604 |
| UserType |
integer |
组织成员的用户类型。取值范围:
|
1 |
| Success |
boolean |
是否请求成功。取值范围:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"AccountName": "xxxxxx@163.com",
"AdminUser": true,
"AuthAdminUser": true,
"NickName": "张三",
"RoleIdList": [
111111111
],
"UserId": "b5d8fd9348cc4327****afb604",
"UserType": 1
},
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Organization.Developers.ReachedTheUpperLimit | The developers of the organization have reached the upper limit:%s | 组织开发者已达到上限 %s 人,请升级联系组织管理员升级开发者数量。 |
| 400 | Organization.Viewers.ReachedTheUpperLimit | The visitors of the organization have reached the upper limit:%s. | 组织访问者已达到上限%s人,请升级联系组织管理员升级访问者数量。 |
| 400 | Organization.Analysts.ReachedTheUpperLimit | The analysts of the organization have reached the upper limit:%s. | 组织分析师已达到上限%s人,请升级联系组织管理员升级分析师数量。 |
| 400 | NickName.AlreadyIn.Organization | The alias already exists. | 昵称已存在。 |
| 400 | User.AlreadyIn.Organization | This user is already a member of the current organization. | 该用户已在当前组织中。 |
| 400 | Instance.Over.MaxLicense | You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first. | |
| 400 | AnalystUser.NotSupport.AdminOrDevRole | Analyst users do not support granting workspace administrator or developer roles. | 分析师用户不支持授予工作空间管理员或开发者员角色。 |
| 400 | Workspace.Not.Exist | The group workspace does not exist. | 群空间不存在。 |
| 400 | Workspace.Type.Error | The type of group workspace is invalid. | 无效的群空间类型。 |
| 400 | Viewer.AddInTo.Workspace | Organization members with viewer type are not allowed to add to workspace: %s. | 不允许将组织的访客类型用户添加到工作空间:%s。 |
| 400 | User.AlreadyIn.Workspace | This user already exists. | 该用户已在群空间中。 |
| 400 | User.AlreadyIn.Role | The user is already assigned this role. | 用户已经拥有该角色。 |
| 400 | User.OrganizationRole.NotExist | User %s must have role in organization. | 用户 %s 在组织中必须有一个角色。 |
| 400 | Viewer.CannotHave.CustomRole | Organization viewer cannot have custom roles. | 组织访问者不能具有自定义角色。 |
| 400 | UserAnalyst.NotSupport.ThisRole | This role has permissions that analysts cannot grant. | 该角色具有分析员无法授予的权限。 |
| 400 | RoleCount.ExceedsLimit.Error | The user role cannot exceed three. | 用户角色不能超过三个。 |
| 400 | BindRole.NotExist.Error | Bind role not exist, %s. | 绑定的角色不存在,%s。 |
| 400 | DirtyData.Duplicate.User | Dirty data,duplicate user: %s. | 脏数据,重复的用户:%s。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。