跳转至

向用户组添加用户

1. 接口说明

用于向用户组添加用户

2. 接口URL

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

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

3. 公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户 ID,用于标识资源所属租户
auth-type String 认证方式:
UID:使用 UID 认证
APIKEY:使用 APIKEY 认证
ACCOUNT:使用 ACCOUNT 认证
auth-value String 与 auth-type 对应的认证值

3.1 公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取租户 ID 与认证值。

image.png

3.2. 请求体参数:

参数 类型 是否必选 描述
identityType String 用户标识类型(USER_ID 或 USER_ACCOUNT)
identityIds Array 用户ID列表或用户账号列表
value String 用户组ID或用户组编码
groupIdentityType String 用户组标识类型(USER_GROUP_ID 或 USER_GROUP_CODE)

4. 请求示例:

curl --location 'http://localhost:8083/anymetrics/api/v1/userGroup/addUser' \
--header 'tenant-id: tn_21571046' \
--header 'auth-value: authority_test' \
--header 'auth-type: ACCOUNT' \
--header 'Content-Type: application/json' \
--data '{
  "identityType": "USER_ACCOUNT",
  "identityIds": ["zhangsan"],
  "value": "g_1001",
  "groupIdentityType": "USER_GROUP_ID"
}'

5. 返回示例:

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "78f6b068f84545aea98460f6f5b0627e.196.17761397786262087"
}