EditControlGroup
Update time: 2025-11-07 11:50:49
This interface is used to modify the information of a specified ControlGroup, including the name, domain list, and account list of the ControlGroup. Users can choose to update by either overwriting or appending as needed. For custom-type ControlGroups, users can modify their name and domain list, while client-type and contract-type ControlGroups do not allow such modifications. Additionally, users can specify a list of accounts with access permissions for the ControlGroup. This interface facilitates flexible management of ControlGroup configuration, allowing users to control access permissions and applicability by adjusting these settings, thereby better serving business needs.
- Data latency: 5-15 minutes
- Limit of request rate per user: 30/5min
- Applicable Products: IAM
For API authentication details, please refer to: API Authentication Overview
Request
Path Params
| Name | Description |
|---|---|
*ControlGroupCodeString | Control Group Code, Can be obtained through the API interface [QueryControlGroupList] |
Body Params
| Name | Description |
|---|---|
controlGroupNameString | Control Group name, which only the User Customized type Control Group can be modified, customer type Control Group and product type Control Group can not be modified. User Customized type Control Group keeps the original Control Group name if no value is passed |
accountListList | Account object array,Used to specify accounts with permission. all types of Control Group can be modified, if no value is passed, the original accountList will be emptied |
loginNameString | Account |
domainListList | Domain array, which only the User Customized type Control Group can be modified, customer type Control Group and product type Control Group can not be modified.User Customized type Control Group empties the original domainList if no value is passed |
isAddBoolean | Whether to add:
1. Do not pass or pass false: rewrite method;
2. Pass true: append method. |
Response
Body Params
| Name | Description |
|---|---|
codeInteger | Status Code |
msgString | Message |
dataObject | |
controlGroupCodeString | Control Group Code |
controlGroupNameString | Control Group Name |
requestIdString | Request ID |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| 24192105 | The "controlGroupName"you specified is not exist | 200 | The "controlGroupName"you specified is not exist |
| 24192107 | You do not have permission to operate this "controlGroup" | 200 | You do not have permission to operate this "controlGroup" |
| 24192109 | The "controlGroup" you specified does not belong to you | 200 | The "controlGroup" you specified does not belong to you |
| 24192103 | ccbc_control_group_add_account_illegal:xx | 200 | ccbc_control_group_add_account_illegal:xx |
Example
JSON
- Request example Copy success
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/user/control-groups/<ControlGroupCode>" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -d '{ "accountList":[{"loginName":"test1"},{"loginName":"test2"}], "controlGroupName":"xxx", "domainList":["www.aaa.com","www.bbb.com"], "isAdd":"false" }'- Response example Copy success
{ "msg":"Success", "code":"0", "data":{ "controlGroupCode":"CG201906241004", "controlGroupName":"xxx" } }
Is the content of this document helpful to you?
Yes
I have suggestion