产品概述
相关概念
Domain name for API request: organization.intl.tencentcloudapi.com.
This API is used to modify user group information.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: UpdateGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2021-03-31. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Space ID. |
| GroupId | Yes | String | User group ID. |
| NewGroupName | No | String | New user group name. |
| NewDescription | No | String | New user group description. |
| Parameter Name | Type | Description |
|---|---|---|
| GroupInfo | GroupInfo | User group information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to modify the user group information.
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateGroup
<Common request parameters>
{
"ZoneId": "z-s8shs8bd***",
"GroupId": "g-s8dhdn3",
"NewGroupName": "testGroup",
"NewDescription": "this is group."
}
{
"Response": {
"GroupInfo": {
"GroupName": "testGroup",
"Description": "this is group",
"CreateTime": "2024-01-01 12:12:12",
"GroupType": "Manual",
"UpdateTime": "2024-01-01 12:12:12",
"GroupId": "g-w8hd8n***",
"MemberCount": 20
},
"RequestId": "e297543a-80de-4039-83c8-9d324545"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.IdentityCenterNotOpen | The CIC service is not enabled. |
| FailedOperation.ManualGroupNotUpdate | Manually created user groups cannot be updated. |
| FailedOperation.SynchronizedGroupNotUpdate | The synchronized user group cannot be updated. |
| FailedOperation.ZoneIdNotExist | The user zoneId of the CIC service does not exist. |
| InvalidParameter.GroupNameAlreadyExists | The user group name already exists. |
| InvalidParameter.GroupNotExist | The user group does not exist. |
文档反馈