All Products
Search
Document Center

Quick BI:AddUser

Last Updated:Nov 04, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Add an organization member.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:AddUsercreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AdminUserdeprecatedbooleanNo

Whether to assign the organization administrator role. Value range:

  • true: Yes
  • false: No

Notice This parameter is deprecated and not recommended for use. It is invalid when RoleIds is provided.

true
AuthAdminUserdeprecatedbooleanNo

Whether to assign the organization permission administrator role. Value range:

  • true: Yes
  • false: No

Notice This parameter is deprecated and not recommended for use. It is invalid when RoleIds is provided.

true
UserTypeintegerYes

The user type of the organization member. Value range:

  • 1: Developer
  • 2: Visitor
  • 3: Analyst
1
AccountNamedeprecatedstringYes

Aliyun account name.

  • Note: If it is a sub-account, the format should be 'primary account: sub-account'. For example: master_test@aliyun.com:subaccount
  • Format check: Maximum length of 50 characters.
xxxxxx@163.com
NickNamestringYes

Aliyun account nickname.

  • Format check: Maximum length of 50 characters.
  • Special format validation: Chinese and English characters, numbers, _ \ / | () ] [
ddd
RoleIdsstringNo

Preset or custom organization role IDs bound to the user, separated by commas, with a maximum of 3. Value range:

  • Organization Administrator (preset role): 111111111
  • Permission Administrator (preset role): 111111112
  • Regular User (preset role): 111111113
111111111,456

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

Returns detailed information about the newly added Aliyun user.

AccountNamestring

Aliyun account.

xxxxxx@163.com
AdminUserboolean

Whether the organization administrator role is assigned. Value range:

  • true: Yes
  • false: No

Notice This parameter is deprecated and not recommended for use. It is invalid when RoleIdList is provided.

true
AuthAdminUserboolean

Whether the permission administrator role is assigned. Value range:

  • true: Yes
  • false: No

Notice This parameter is deprecated and not recommended for use. It is invalid when RoleIdList is provided.

true
NickNamestring

Aliyun account nickname.

ddd
RoleIdListarray

List of organization role IDs bound to the user.

RoleIdListlong

Organization role IDs, up to 3, including but not limited to preset roles:

  • Organization Administrator (preset role): 111111111
  • Permission Administrator (preset role): 111111112
  • Regular User (preset role): 111111113
111111111
UserIdstring

UserID in Quick BI.

b5d8fd9348cc4327****afb604
UserTypeinteger

User type of the organization member. Value range:

  • 1: Developer
  • 2: Visitor
  • 3: Analyst
1
Successboolean

Indicates whether the request was successful. Possible values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountName": "xxxxxx@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "NickName": "ddd",
    "RoleIdList": [
      111111111
    ],
    "UserId": "b5d8fd9348cc4327****afb604",
    "UserType": 1
  },
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Organization.Developers.ReachedTheUpperLimitThe developers of the organization have reached the upper limit:%sThe developers of the organization have reached the upper limit:%s
400Organization.Viewers.ReachedTheUpperLimitThe visitors of the organization have reached the upper limit:%s.The visitors of the organization have reached the upper limit:%s.
400Organization.Analysts.ReachedTheUpperLimitThe analysts of the organization have reached the upper limit:%s.The analysts of the organization have reached the upper limit:%s.
400NickName.AlreadyIn.OrganizationThe alias already exists.The alias already exists.
400User.AlreadyIn.OrganizationThis user is already a member of the current organization.This user is already a member of the current organization.
400User.AlreadyIn.OrganizationThe user already exists.The 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.You 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.The group workspace does not exist.
400Workspace.Type.ErrorThe type of group workspace is invalid.The type of group workspace is invalid.
400Viewer.AddInTo.WorkspaceOrganization members with viewer type are not allowed to add to workspace: %s.Organization members with viewer type are not allowed to add to workspace: %s.
400User.AlreadyIn.WorkspaceThis user already exists.This user already exists.
400User.AlreadyIn.RoleThe user is already assigned this role.The user is already assigned this role.
400User.OrganizationRole.NotExistUser %s must have role in organization.User %s must have role in organization.
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.Organization viewer cannot have custom roles.
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.This role has permissions that analysts cannot grant.
400RoleCount.ExceedsLimit.ErrorThe user role cannot exceed three.The user role cannot exceed three.
400BindRole.NotExist.ErrorBind role not exist, %s.Bind role not exist, %s.
400DirtyData.Duplicate.UserDirty data,duplicate user: %s.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-26The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-08-07The Error code has changedView Change Details