Call UpdateWorkspaceUsersRole to batch update workspace member roles - Quick BI - Alibaba Cloud - Quick BI

Updates the roles of workspace members in batches. Existing roles are overwritten.

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

update

*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. The IDs are Quick BI user IDs, not Alibaba Cloud UIDs. You can specify multiple user IDs separated by commas (,).	136516262323**,124498444445**
RoleId	integer	Yes	The ID of the preset workspace role. Existing roles are overwritten. Valid values: 25: workspace administrator 26: workspace developer 27: workspace analyst 30: workspace viewer Valid values: 25 : Workspace administrator. 26 : Workspace developer. 27 : Workspace analyst. 30 : Workspace 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 updated successfully while others fail. For the failure reasons, refer to FailureDetail in the response. false: The request fails and 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 whose roles failed to be updated.	0
FailureDetail	object	The reasons for the update failures.
Success	integer	The number of users whose roles were successfully updated.	2
Total	integer	The total number of users to be updated.	2

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 0,
    "FailureDetail": {
      "test": "test",
      "test2": 1
    },
    "Success": 2,
    "Total": 2
  }
}

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	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	Remove.AdminRoleOf.WorkspaceOwner	The owner of the group workspace must be assigned the administrator role.	The owner of the group workspace must be assigned the administrator role.
400	User.NotIn.Workspace	The user is not a member of the group workspace.	The user is not a member of the group workspace.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.