Call the AddUser API to add an organization member - Quick BI - Alibaba Cloud - Quick BI

Adds an organization member.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:AddUser

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AdminUser `deprecated`	boolean	No	Specifies whether to assign the organization administrator role. Valid values: true: Yes. false: No. Important This parameter is deprecated. When RoleIds is specified, this parameter does not take effect.	true
AuthAdminUser `deprecated`	boolean	No	Specifies whether to assign the organization permission management administrator role. Valid values: true: Yes. false: No. Important This parameter has expired and is no longer recommended. When RoleIds is specified, this parameter does not take effect.	true
UserType	integer	Yes	The user type of the organization member. Valid values: 1: Developer. 2: Visitor. 3: Analyst. Valid values: 1 : Developer. 2 : Visitor. 3 : Analyst.	1
AccountId	string	No	The Alibaba Cloud account ID. Warning For Quick BI versions released after December 31, 2024, AccountId is a required parameter. Update your API calls before this date.	191476xxxxx23754
AccountName `deprecated`	string	No	The Alibaba Cloud account name. Note: For a RAM user, the format is "primary account:RAM user". Example: master_test@aliyun.com:subaccount Format check: The maximum length is 50 characters.	xxxxxx@163.com
NickName	string	Yes	The nickname of the Alibaba Cloud account. Format check: The maximum length is 50 characters. Special character validation: Chinese characters, English characters, digits, _ \ / \| () ] [	John
RoleIds	string	No	The IDs of preset or custom organization roles to attach to the user, separated by commas (,). A maximum of three role IDs are supported. Valid values: Organization administrator (preset role): 111111111 Permission management administrator (preset role): 111111112 Common user (preset role): 111111113	111111111,456
CopilotModules	string	No	The intelligent module quotas of the user. Separate multiple modules with commas (,). qreport -- Small Q Report qExploreNum -- Small Q Explorer smartQAskNum -- Small Q Ask smartQDevNum -- Small Q Builder	qreport,qExploreNum

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The details of the newly added Alibaba Cloud user.
AccountName	string	The Alibaba Cloud account.	xxxxxx@163.com
AdminUser	boolean	Indicates whether the organization administrator role is bound. Valid values: true: Yes. false: No. Important This parameter is deprecated. When RoleIdList is specified, this parameter does not take effect.	true
AuthAdminUser	boolean	Indicates whether the permission management administrator role is attached. Valid values: true: Yes. false: No. Important This parameter has expired and is no longer recommended. When RoleIdList is specified, this parameter does not take effect.	true
NickName	string	The nickname of the Alibaba Cloud account.	John
RoleIdList	array	The list of organization role IDs bound to the user.
	integer	The organization role ID. A maximum of three role IDs are supported, including but not limited to the following preset roles: Organization administrator (preset role): 111111111 Permission management administrator (preset role): 111111112 Common user (preset role): 111111113	111111111
CopilotModules	array	The intelligent module quotas owned by the user.
	string	The intelligent module quotas owned by the user.	qreport
UserId	string	The user ID in Quick BI.	b5d8fd9348cc4327****afb604
UserType	integer	The user type of the organization member. Valid values: 1: Developer. 2: Visitor. 3: Analyst.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	Organization.Developers.ReachedTheUpperLimit	The developers of the organization have reached the upper limit:%s	The developers of the organization have reached the upper limit:%s
400	Organization.Viewers.ReachedTheUpperLimit	The visitors of the organization have reached the upper limit:%s.	The visitors of the organization have reached the upper limit:%s.
400	Organization.Analysts.ReachedTheUpperLimit	The analysts of the organization have reached the upper limit:%s.	The analysts of the organization have reached the upper limit:%s.
400	NickName.AlreadyIn.Organization	The alias already exists.	The alias already exists.
400	User.AlreadyIn.Organization	This user is already a member of the current 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.	The group workspace does not exist.
400	Workspace.Type.Error	The type of group workspace is invalid.	The type of group workspace is invalid.
400	Viewer.AddInTo.Workspace	Organization 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.
400	User.AlreadyIn.Workspace	This user already exists.	This user already exists.
400	User.AlreadyIn.Role	The user is already assigned this role.	The user is already assigned this role.
400	User.OrganizationRole.NotExist	User %s must have role in organization.	User %s must have role in organization.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	This role has permissions that analysts cannot grant.
400	RoleCount.ExceedsLimit.Error	The user role cannot exceed three.	The user role cannot exceed three.
400	BindRole.NotExist.Error	Bind role not exist, %s.	Bind role not exist, %s.
400	DirtyData.Duplicate.User	Dirty data,duplicate user: %s.	Dirty data. Duplicate user: %s.
400	Robot.Module.Exhausted	The Quota of %s module has been exhausted.	The quota for the %s module has been exhausted.