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

Updates the information of a specified member in an organization.

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

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user to be updated. The user ID is the UserID of the Quick BI, not the UID of Alibaba Cloud.	fe67f61a35a94b7da1a34ba174a7****
AdminUser	boolean	No	Indicates whether the organization administrator. Valid values: true false	true
AuthAdminUser	boolean	No	Indicate whether the RAM user is a permission administrator. Valid values: true false	true
UserType	integer	No	The type of user who is a member of the organization. Valid values: 1 : developer 2 : visitors 3 : Analyst	1
NickName	string	No	The nickname of the account. Format check: The value can be up to 50 characters in length. Special format verification: Chinese and English digits_ \ / \| () ] [	Xiao Zhang
RoleIds	string	No	The IDs of the preset or custom organization roles bound to the user, separated by English commas ',', with a maximum of 3. The value range is as follows: - Organization Administrator (preset role): 111111111 - Permission Administrator (preset role): 111111112 - Regular User (preset role): 111111113	111111111,456
IsDeleted	boolean	No	User status: false: Active true: Inactive	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	boolean	The execution result of the interface is returned. Valid values: true: The request was successful. false: The request fails.	true
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": true,
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-02-26	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-08-07	The Error code has changed	View Change Details

HTTP status code	Error code	Error message	Description
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	NickName.AlreadyIn.Organization	The alias already exists.	The alias already exists.
400	Fobbiden.Action	The organization owner must have the administrator role.	The organization owner must have the administrator role.
400	Invalid.User.Organization	The user is not in your organization.	The user is not in your organization.
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	Instance.Over.MaxLicense	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Mail.Invalid	Email/phone number is invalid.	-
400	OrganizationDeveloper.CanNotChangeTo.AnalystOrViewer	Organization user can not change developer to analyst or viewer.	-
400	OrgAdminOrPermissionAdmin.CannotChangeTo.Viewer	Organization admin or permission admin can not change to viewer.	-
400	ChangeTo.Viewer.Error	The organization user type cannot be changed because the user already belongs to a workspace.	-
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	User.OrganizationRole.NotExist	User %s must have role in organization.	User %s must have role in organization.
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.