Call CreateUserGroup to create a user group - Quick BI - Alibaba Cloud - Quick BI

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserGroupId	string	No	The unique ID of the user group. If you specify the UserGroupId parameter, the system automatically generates the UserGroupId parameter. If you specify the UserGroupId parameter, the user ID is used as the user group ID. You must ensure that the user ID is unique within the organization. Maximum length: 64. Cannot be -1.	pop0001
UserGroupName	string	Yes	The name of the user group. Maximum length: 255. Allowed characters: Chinese characters, letters, digits, _, \, /, \|, (, ), ], and [.	杭州财报
UserGroupDescription	string	No	The description of the user group. Maximum length: 255. Allowed characters: Chinese characters, letters, digits, _, \, /, \|, (, ), ], and [.	用户分组描述
ParentUserGroupId	string	Yes	The ID of the parent user group. If you specify a parent user group ID, the new user group is created under that group. If you set this parameter to -1, the new user group is created in the root directory.	3d2c23d4-2b41-4af8-a1f5-f6390f32****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	36829379-0C38-5BC0-830A-92665BF77D4F
Result	string	The ID of the created user group. An empty string is returned if the operation fails.	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "36829379-0C38-5BC0-830A-92665BF77D4F",
  "Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	Usergroup.Not.Exist	The user group does not exist.
400	Duplicate.Name.Error	The name already exists.
400	UserGroup.Parent.NotFound	The parent user group does not exist.
400	Duplicate.UserGroup.Id	Duplicated usergroupId %s.
400	RootUserGroup.Create.Error	organization %s has synchronized with other organizational structures, so user groups cannot be created under the root 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.Layer.Limited	The user group cannot have more than ten layers.
400	UserGroup.ExceedsLimit.Error	User group exceed limit, %s.
400	Duplicate.UserGroupName.Error	There is already a user group with the same name %s, please rename it before saving.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.