UpdateWorkspaceUserRole - 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.

Modify the role of a specified member under the workspace, existing roles will be overwritten.

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:UpdateWorkspaceUserRole	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserId	string	Yes	Quick BI user ID.	f5698bedeb384b1986afccd9e434****
RoleId`deprecated`	long	No	Preset workspace role ID, existing roles will be overwritten. Value range: 25: Workspace Administrator 26: Workspace Developer 27: Workspace Analyst 30: Workspace Viewer	25
RoleIds	string	No	Multiple workspace role IDs, separated by commas. If this value is provided, it takes precedence. Notice roleId and roleIds cannot both be empty	25,26

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	boolean	Returns the result of the interface execution. Value range: true: Execution successful false: Execution failed	true
Success	boolean	Indicates whether the request was successful. Value range: true: Request successful false: Request failed	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": true,
  "Success": true
}

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	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	User.NotIn.Workspace	The user is not a member of the group workspace.	The user is not a member of the group workspace.
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.RoleType.Valid	The role ID is invalid.	The role ID is invalid.
400	User.AlreadyIn.Role	The user is already assigned this role.	The user is already assigned this role.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.	-
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	This role has permissions that analysts cannot grant.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	Organization viewer cannot have custom roles.
400	BindRole.NotExist.Error	Bind role not exist, %s.	Bind role not exist, %s.
400	Name.RegularExpression.Error	Name format validation failed.	-
400	NameExceeded.MaxLength.Error	The name cannot exceed %s characters in length.	The name cannot be longer than% s characters.

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
2023-04-06	The Error code has changed	View Change Details