TransferUsergroup - Quick BI - Alibaba Cloud Documentation Center

Migrates a user group.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
UserGroupId	string	Yes	The ID of the user group to migrate.	12qwda****sdada
ParentUserGroupId	string	Yes	The ID of the parent user group.	asdasva***123124asdasd

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	boolean	Indicates whether the migration was successful.	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	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	Usergroup.Not.Exist	The user group does not exist.	The user group does not exist.
400	UserGroup.Parent.NotFound	The parent user group does not exist.	The parent user group does not exist.
400	DeletePermission.UserBelongsToUsergroup.Error	cannot be deleted because user belongs to usergroup: %s.	cannot be deleted because user belongs to usergroup: %s.
400	Duplicate.UserGroup.Id	Duplicated usergroupId %s.	Duplicate usergroupId %s.
400	Duplicate.UserGroupName.Error	There is already a user group with the same name %s, please rename it before saving.
400	RootUserGroup.Create.Error	organization %s has synchronized with other organizational structures, so user groups cannot be created under the root user group.
400	User.CanOnlyAddTo.BIUserGroup	User can only add to BI user group.	Users can only add to BI user group.
400	UserGroup.Already.Synchronized	Organization has synchronized with other organizational structures, so you are not allowed to add users under group.
400	Usergroup.CannotTransfer.OtherOrganzation	usergroup can't be transfered to other organization.	usergroup can't be transfered to other organization.
400	Usergroup.CannotTransfer.UnderChildren	usergroup can't be transfered to under chidlren.	usergroup can't be transfered to under chidlren.
400	UserGroup.ExceedsLimit.Error	User group exceed limit, %s.	User Grouping Restrictions
400	Usergroup.TransferNotChanged.Error	usergroup can't be transfered without any changed.	usergroup can't be transfered without any changed.
400	Usergroup.TypeTransfer.NotSupport	Unsupported type of user group or target user group.	Unsupported type of user group or target user group.
500	UserGroup.Update.RootNode	The root user group cannot be updated.	The root user group cannot be updated.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.