AddWorkspaceUsers - Quick BI - Alibaba Cloud Documentation Center

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.

Batch add members to the workspace.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:AddWorkspaceUsers	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	Yes	User ID. This is the UserID for Quick BI, not the Alibaba Cloud UID. Supports batch parameters, with user IDs separated by commas (,).	de4bc5f9429141cc8091cdd1c15b****
RoleId	long	Yes	Preset space role ID. Value range: 25: Space Administrator 26: Space Developer 27: Space Analyst 30: Space Viewer	25

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Value range: true: The request was successful. There may be cases where some members are added successfully and others fail. For the reasons of failure, refer to the FailureDetail in the response. false: The request failed, and no data will be persisted.	true
RequestId	string	Request ID.	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	Returns the result of the API execution.
Failure	integer	Number of users that failed to be added.	2
FailureDetail	object	Reasons for the failures.	{"2046274934845893" : "AE0150010001: This user already exists.", "1213444447906552" : "AE0150010001: This user already exists."}
Success	integer	Number of users that were added successfully.	1
Total	integer	Total number of users being added.	3

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time	Summary of changes	Operation
2023-08-07	The Error code has changed	View Change Details