Delete an organization user and transfer report resources using DeleteUser - Quick BI - Alibaba Cloud - Quick BI

Deletes an organization user.

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

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The ID of the user to delete. This is the Quick BI UserID, not the Alibaba Cloud UID.	fe67f61a35a94b7da1a34ba174a7****
TransferUserId	string	No	The ID of the user who receives the deleted user's workspace resources. If empty, resources transfer to the workspace owner. The successor cannot be an organization visitor. The successor's workspace permissions must be equal to or higher than those of the deleted user (management > development > sharing > viewing). If the successor is not in the workspace, they are automatically added.	f5****afccd9e434a274

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	boolean	Whether the deletion succeeded. Valid values: true: succeeded false: failed	true
Success	boolean	Whether the request succeeded. Valid values: true: succeeded false: 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	CannotRemove.OrganizationOwner	You cannot remove the organization owner from the organization.	You cannot remove the organization owner from the organization.
400	Member.ExistInWorkspace.Error	You cannot remove a user who is a member of a group workspace.	You cannot remove a user who is a member of a group workspace.
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	Not.Organization.AuthAdmin	You are not a role administrator of the organization and do not have the permission to perform the operation.	You are not a role administrator of the organization and do not have the permission to perform the operation.
400	Works.Transfer.Error	You are not authorized to transfer this item.	You are not authorized to transfer this item.
400	CanNot.Remove.WorkspaceOwner	You cannot remove the group workspace owner from the group.	You cannot remove the group workspace owner from the group.
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	Transfer.TargetUser.NotExist	The new owner does not exist. Please ensure that the target user has logged on to the system.	The new owner does not exist. Please ensure that the target user has logged on to the system.
400	User.RoleType.Valid	The role ID is invalid.	The role ID is invalid.
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	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	This role has permissions that analysts cannot grant.
400	Transfer.Not.Allowed	Transfer to users with lower space permissions is not allowed.	Transfer to users with lower space permissions is not allowed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.