AddUser - 添加组织成员

添加组织成员。

调试

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

授权信息

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

请求参数

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

是否赋予组织管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,当传入 RoleIds 时该参数无效。

true
AuthAdminUserboolean

是否赋予组织权限管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,当传入 RoleIds 时该参数无效。

true
UserTypeinteger

组织成员的用户类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
1
AccountNamestring

阿里云账号名称。

  • 说明:如果是子账号,格式为『主账号:子账号』。例如:master_test@aliyun.com:subaccount
  • 格式检查:最大长度 50 个字符。
xxxxxx@163.com
NickNamestring

阿里云账号昵称。

  • 格式检查:最大长度 50 个字符。
  • 特殊格式校验:中英文数字 _ \ / | () ] [
张三
RoleIdsstring

用户绑定的预置或自定义组织角色 ID,用英文逗号“,”分割,最多 3 个。取值范围:

  • 组织管理员(预置角色):111111111
  • 权限管理员(预置角色):111111112
  • 普通用户(预置角色):111111113
111111111,456

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回新增阿里云用户的详细信息。

AccountNamestring

阿里云账户。

xxxxxx@163.com
AdminUserboolean

是否绑定了组织管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,当传入 RoleIdList 时该参数无效

true
AuthAdminUserboolean

是否绑定了权限管理员角色。取值范围:

  • true:是
  • false:否

注意 参数已过期不推荐使用,当传入 RoleIdList 时该参数无效

true
NickNamestring

阿里云账号昵称。

张三
RoleIdListarray

用户绑定的组织角色 ID 列表。

RoleIdListlong

组织角色 ID,最多 3 个,包括但不限于组织预置角色:

  • 组织管理员(预置角色):111111111
  • 权限管理员(预置角色):111111112
  • 普通用户(预置角色):111111113
111111111
UserIdstring

Quick BI 中的 UserID。

b5d8fd9348cc4327****afb604
UserTypeinteger

组织成员的用户类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
1
Successboolean

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

  • true:请求成功
  • false:请求失败
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错误码错误信息描述
400Organization.Developers.ReachedTheUpperLimitThe developers of the organization have reached the upper limit:%s组织开发者已达到上限 %s 人,请升级联系组织管理员升级开发者数量。
400Organization.Viewers.ReachedTheUpperLimitThe visitors of the organization have reached the upper limit:%s.组织访问者已达到上限%s人,请升级联系组织管理员升级访问者数量。
400Organization.Analysts.ReachedTheUpperLimitThe analysts of the organization have reached the upper limit:%s.组织分析师已达到上限%s人,请升级联系组织管理员升级分析师数量。
400NickName.AlreadyIn.OrganizationThe alias already exists.昵称已存在。
400User.AlreadyIn.OrganizationThis user is already a member of the current organization.该用户已在当前组织中。
400User.AlreadyIn.OrganizationThe user already exists.该用户已在其他组织中。
400Instance.Over.MaxLicenseYou have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.您可以添加的用户已达上限,请升级配置或移除其它用户后再添加。
400AnalystUser.NotSupport.AdminOrDevRoleAnalyst users do not support granting workspace administrator or developer roles.分析师用户不支持授予工作空间管理员或开发者员角色。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
400Workspace.Type.ErrorThe type of group workspace is invalid.无效的群空间类型。
400Viewer.AddInTo.WorkspaceOrganization members with viewer type are not allowed to add to workspace: %s.不允许将组织的访客类型用户添加到工作空间:%s。
400User.AlreadyIn.WorkspaceThis user already exists.该用户已在群空间中。
400User.AlreadyIn.RoleThe user is already assigned this role.用户已经拥有该角色。
400User.OrganizationRole.NotExistUser %s must have role in organization.用户 %s 在组织中必须有一个角色。
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.组织访问者不能具有自定义角色。
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.该角色具有分析员无法授予的权限。
400RoleCount.ExceedsLimit.ErrorThe user role cannot exceed three.用户角色不能超过三个。
400BindRole.NotExist.ErrorBind role not exist, %s.绑定的角色不存在,%s。

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

变更历史

变更时间变更内容概要操作
2024-02-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-07OpenAPI 错误码发生变更查看变更详情