UpdateUser-阿里云帮助中心

Updates the information of a specified member in an organization.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user to update. This user ID is the Quick BI UserID, not the Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****
AdminUser	boolean	No	Specifies whether to assign the organization administrator role. Valid values: true: Yes. false: No. Important This parameter is deprecated. When RoleIds is specified, this parameter does not take effect.	true
AuthAdminUser	boolean	No	Specifies whether to assign the organization permission management administrator role. Valid values: true: Yes. false: No. Important This parameter has expired and is not recommended. When RoleIds is specified, this parameter does not take effect.	true
UserType	integer	No	The user type of the organization member. Valid values: 1: Developer. 2: Visitor. 3: Analyst.	1
NickName	string	No	The nickname. Format check: The maximum length is 50 characters. Special format check: Chinese characters, English characters, digits, _ \ / \| () ] [	test
RoleIds	string	No	The IDs of preset or custom organization roles to attach to the user, separated by commas (,). A maximum of three role IDs are supported. Valid values: Organization administrator (preset role): 111111111 Permission management administrator (preset role): 111111112 Common user (preset role): 111111113	111111111,456
IsDeleted	boolean	No	The user status. Valid values: false: Activated. true: Deactivated.	false
CopilotModules	string	No	The intelligent module quota modification information. Pass the parameter as a JSON array. Each array element contains the following fields: moduleType -- The intelligent module. smartQAskNum -- Smart Q questions. smartQDevNum -- Smart Q building. qreport -- Smart Q reports. qExploreNum -- Smart Q exploration edition. status -- Specifies whether to enable the module. 0 -- Revoke authorization. 1 -- Grant authorization.	[ { "moduleType": "smartQAskNum", "status": 1 }, { "moduleType": "smartQDevNum", "status": 0 } ]

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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	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.
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.
400	Robot.Module.Exhausted	The Quota of %s module has been exhausted.	The quota for the %s module has been exhausted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.