All Products
Search
Document Center

Quick BI:CreateUserGroup

Last Updated:Nov 04, 2025

Create a user group. You can specify a parent user group.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:CreateUserGroupcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserGroupIdstringNo

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.
  • Format verification: Maximum length 64, cannot be -1,
pop0001
UserGroupNamestringYes

The name of the RAM user group.

  • Format verification: Maximum length 255
  • Special format verification: Chinese and English digits_ \ / | () ] [
Hangzhou Financial Report
UserGroupDescriptionstringNo

The description of the user group.

  • Format verification: Maximum length 255
  • Special format verification: Chinese and English digits_ \ / | () ] [
User group description
ParentUserGroupIdstringYes

The ID of the parent user group. You can add new user groups to this group:

  • If you enter the ID of a parent user group, the new user group is added to the user group with the ID.
  • If you enter -1, the new user group is added to the root directory.
3d2c23d4-2b41-4af8-a1f5-f6390f32****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

36829379-0C38-5BC0-830A-92665BF77D4F
Resultstring

The ID of the added user group is returned. An empty string '' is returned if the add fails.

f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
400Usergroup.Not.ExistThe user group does not exist.The user group does not exist.
400Duplicate.Name.ErrorThe name already exists.The name already exists.
400UserGroup.Parent.NotFoundThe parent user group does not exist.The parent user group does not exist.
400Duplicate.UserGroup.IdDuplicated usergroupId %s.Duplicate usergroupId %s.
400Invalid.Parameter.ErrorThe parameter is invalid:%s.invalid parameter: ${0}.
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
400Invalid.Param.ErrorThe parameter is invalid.The parameter is invalid.
400Invalid.User.AdminYou are not an administrator of this organization.Only organization administrators can perform this operation.
400System.Param.EmptyYou must specify the %s parameter.You must specify the %s parameter.
400UserInfo.ErrorThe personal information is invalid.The personal information is invalid.
400ApiUser.Not.ExistsThe specified user does not exist.The specified user does not exist.

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

Change history

Change timeSummary of changesOperation
2023-06-20The Error code has changedView Change Details
2023-05-10The Error code has changedView Change Details