跳转至

创建用户组

1. 接口说明

用于管理用户组的创建

2. 接口URL

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

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 请求体参数:

参数 类型 是否必选 描述
groups Array 用户组列表
∟ name String 用户组名称
∟ description String 用户组描述
∟ parentGroupId String 父用户组 ID 或 code(code 模式下支持 code)
∟ code String 用户组编码(code 模式下必传)

4. 请求示例:

curl --location 'http://localhost:8083/anymetrics/api/v1/userGroup/create' \
--header 'tenant-id: tn_21571046' \
--header 'auth-value: authority_test' \
--header 'auth-type: ACCOUNT' \
--header 'Content-Type: application/json' \
--data '{
  "groups": [
    {
      "name": "华东销售组",
      "description": "华东区域销售人员",
      "parentGroupId": "g_root",
      "code": "EAST_SALES"
    }
  ]
}'

5. 返回示例:

{
    "data": [
        "17222d20-4a6f-43bf-a0d3-f7911c1eee19"
    ],
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "27cb89dae3b64e238acc50d5458e93e5.187.17760667176470703"
}