Skip to content

List user Group Members

1. API Description

Use this API to query the user list of a specified user group.

2. API URL

POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/userGroup/member/list

To obtain anymetrics_host:anymetrics_port, see Calling APIs.

3. Common Request Headers

parameter Type required Description
tenant-id String Yes Tenant ID that identifies the tenant to which the resource belongs.
auth-type String Yes Authentication method. Supports UID, TOKEN, ACCOUNT, and APIKEY.
auth-value String Yes Authentication value corresponding to auth-type.

3.1 How to Obtain Common parameters

In Aloudata CAN, select Metric Applications in the top navigation bar, then select API Integration in the left navigation menu. You can obtain tenant-id on the API Integration page. Set auth-value according to auth-type.

image.png

3.2. Request Body parameters:

parameter Type required Description
groupIdentityType String Yes user group identifier type (USER_GROUP_ID or USER_GROUP_CODE)
value String Yes user group ID or user group code
keyword String No Search keyword (search user account or nickname)
pageNumber Integer Yes Page number，default: 1
pageSize Integer Yes Page size，default: 20

4. Request Example：

curl --location 'http://localhost:8083/anymetrics/api/v1/userGroup/member/list' \
--header 'tenant-id: tn_21571046' \
--header 'auth-value: authority_test' \
--header 'auth-type: ACCOUNT' \
--header 'Content-Type: application/json' \
--data '{
  "groupIdentityType": "USER_GROUP_ID",
  "value": "g_1001",
  "keyword": "zhang",
  "pageNumber": 1,
  "pageSize": 20
}'

5. Response Example：

{
    "data": {
        "data": [
            {
                "userId": "606549427745718272",
                "nickname": "xxx",
                "account": "63689egd",
                "photo": null,
                "cloudAccount": "4lwbtsdjnhmo@aloudata.com",
                "ban": null,
                "creationMode": "SYNC",
                "userSource": null
            }
        ],
        "total": 1,
        "pageNumber": 1,
        "pageSize": 20
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "27cb89dae3b64e238acc50d5458e93e5.188.17761339928042095"
}