Call the AddWorkspaceUsers API to batch add users to a workspace - Quick BI - Alibaba Cloud - Quick BI

Adds members to a workspace in batches.

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:AddWorkspaceUsers

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	Yes	The user IDs. These are Quick BI user IDs, not Alibaba Cloud UIDs. You can pass multiple user IDs separated by commas (,).	de4bc5f9429141cc8091cdd1c15b****
RoleId	integer	Yes	The ID of the preset workspace role. Valid values: 25: storage management administrator 26: workspace developer 27: storage analysis analyst 30: workspace viewer Valid values: 25 : Administrator. 26 : Developer. 27 : Analyst. 30 : Viewer.	25

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. Some members may be added successfully while others fail. For the reasons of failures, refer to FailureDetail in the response. false: The request failed. No data is persisted.	true
RequestId	string	The request ID.	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	The execution result of the operation.
Failure	integer	The number of users that failed to be added.	2
FailureDetail	object	The reasons for the failures.	{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Success	integer	The number of users that were added.	1
Total	integer	The total number of users to be added.	3

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 2,
    "FailureDetail": {
      "2046274934845893": "AE0150010001: This user already exists.",
      "1213444447906552": "AE0150010001: This user already exists."
    },
    "Success": 1,
    "Total": 3
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	User.RoleType.Valid	The role ID is invalid.	The role ID is invalid.
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	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.