QueryControlGroupList

Update time: 2026-07-28 13:52:39

Applicable Products

IAM

API Description

This interface is used to query a list of control groups with access permissions, helping users obtain detailed information about control groups associated with their account. By calling this interface, users can retrieve basic attributes of the control groups, including the name, code, ID, and type. Additionally, the interface provides success or failure status indicators and status messages to help users determine the outcome of the request. This interface is suitable for scenarios where managing and retrieving user permission control group information is needed, assisting users in efficiently maintaining and managing permissions.

Call frequency

Single user trigger frequency: 30/5min

Response parameter(s)

Body Params

NameDescription
codeString
Status Code 200:sueecss, 500:failed
msgString
Message
dataList
CONTROL_GROUP_NAMEString
Control Group Name
CONTROL_GROUP_CODEString
Control Group Code
CONTROL_GROUP_IDString
Control Group ID
CONTROL_GROUP_TYPEString
Control Group Type
requestIdString
Request ID

Error code

Error code(code)Description(message)HTTP statusSemantic
24192110Auth user is empty.200Auth user is empty.
24192011Auth user is not exist.200Auth user is not exist.

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.atomile.com/user/control-groups" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
Response example
Copy Copy success
{
    "msg":"success",
    "code":"0",
    "data":[
        {
            "CONTROL_GROUP_NAME":"xxx1",
            "CONTROL_GROUP_CODE":"CG201906172011",
            "CONTROL_GROUP_ID":"6cd1ae97ae7c47a18fda05a3be944fea",
            "CONTROL_GROUP_TYPE":"Predefined-Product"
        }, {
            "CONTROL_GROUP_NAME":"xxx2",
            "CONTROL_GROUP_CODE":"CG201906172013",
            "CONTROL_GROUP_ID":"d65da61e88f44552a4bcefae9598d7c3",
            "CONTROL_GROUP_TYPE":"Predefined-Customer"
        }, {
            "CONTROL_GROUP_NAME":"xxx3",
            "CONTROL_GROUP_CODE":"CG201906172015",
            "CONTROL_GROUP_ID":"d65da61e88f44552a4bcefae9598d7c3",
            "CONTROL_GROUP_TYPE":"User Customized"
        }]
}