EditControlGroup

Update time: 2023-09-04 10:45:48

Update the specific control group

  • Data latency: 5-15 minutes
  • Single user trigger frequency: 30/5min
  • Applicable Products: IAM

Request

Path Params

NameDescription
*ControlGroupCodeString
Control Group Code

Body Params

NameDescription
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

NameDescription
codeInteger
Status Code
msgString
Message
dataObject
controlGroupCodeString
Control Group Code
controlGroupNameString
Control Group Name

Error code

Error code(code)Description(message)HTTP statusSemantic
MissingBodyThis operation requires a body. Ensure that the body is present and the Content-Type header is set.400Missing request body
HeaderDirectionErrorHeader-direction can only select {0}.400Header-direction can only select {0}.
HttpHeaderXmlErrorMissing "action" or "direction" field in 403Lacking of foeld of action or direction.
InvalidHeaderNameHeader name {0} is no action.404Header name lack of action field
24192105The "controlGroupName"you specified is not exist200The "controlGroupName"you specified is not exist
24192107You do not have permission to operate this "controlGroup"200You do not have permission to operate this "controlGroup"
24192109The "controlGroup" you specified does not belong to you200The "controlGroup" you specified does not belong to you
24192103ccbc_control_group_add_account_illegal:xx200ccbc_control_group_add_account_illegal:xx

Example

JSON
JSON
Request example
Copy 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/CG201906241004" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{
"accountList":[{"loginName":"ctrip_download"}],
"controlGroupName":"xxx",
"domainList":["www.aaa.com","www.bbb.com"],
"isAdd":"false"
}'
Response example
Copy Copy success
{
    "msg":"Success",
    "code":"0",
    "data":{
        "controlGroupCode":"CG201906241003",
        "controlGroupName":"xxx"
    }
}
Is the content of this document helpful to you?
Yes
I have suggestion
Submitted successfully! Thank you very much for your feedback, we will continue to strive to do better!