UpdateUserGroup

Updated at: 2025-04-17 10:31

Updates information about a specified user group in an organization.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
UserGroupIdstringYes

The ID of the user group.

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

The name of the user group.

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

The description of the user group.

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

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4AEF8C5C-D5D2-55D3-BB2F-9D3AA1B6F4FA
Resultboolean

Whether the interface is successfully executed. Valid values:

  • true: The request was successful.
  • false: The request fails.
true
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": "4AEF8C5C-D5D2-55D3-BB2F-9D3AA1B6F4FA",
  "Result": true,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
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.
400Usergroup.Not.ExistThe user group does not exist.The user group does not exist.
400UserGroup.Remove.RootNodeThe root user group cannot be deleted.The root user group cannot be deleted.
400UserGroup.Remove.WithChildrenThis user group contains a child user group and cannot be deleted.This user group contains a child user group and cannot be deleted.
400System.Param.EmptyYou must specify the %s parameter.You must specify the %s parameter.
400Invalid.Parameter.ErrorThe parameter is invalid:%s.invalid parameter: ${0}.
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
400Duplicate.Name.ErrorThe name already exists.The name already exists.
400Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
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.
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
Change timeSummary of changesOperation
2023-06-20The Error code has changedView Change Details
2023-04-06The Error code has changedView Change Details
  • On this page (0)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback