# 用户组

# 获取用户组列表

# 简介

获取指定分页的用户组列表。

# URI

GET /admin-api/socks5_proxy/{id}/user_groups

# URI 参数

  • detail

    type: integer

    required: no

    description: 获取详细的 DNS 应用信息

  • page

    type: integer

    required: no

    description: 第几页,从 1 开始

  • page_size

    type: integer

    required: no

    description: 每页大小,默认 20

# 请求示例

# Shell

curl http://{admin-site}/admin-api/socks5_proxy/3/user_groups?page=1&page_size=20&detail=1

# 响应示例

Status: 200 OK
{
    "data": [
        {
            "label": "test",
            "id": 3,
            "name": "openresty"
        }
    ],
    "status": 0
}

# 添加用户组

# 简介

添加用户组。

# URI

POST /admin-api/socks5_proxy/{id}/user_groups

# JSON Body 参数

  • name

    type: string

    required: no

    description: 用户组名称

  • label

    type: string

    required: no

    description: 标签

# 请求示例

# Shell

curl -X POST http://{admin-site}/admin-api/socks5_proxy/{id}/user_groups -d
'{
    "name": "openresty",
    "label": "test"
}'

# 响应示例

Status: 200 OK
{
    "status": 0,
    "data": {
        "id": 1
    }
}

# 修改用户组

# 简介

修改用户组。

# URI

PUT /admin-api/socks5_proxy/{id}/user_groups/{id}

# JSON Body 参数

  • name

    type: string

    required: no

    description: 用户组名称

  • label

    type: string

    required: no

    description: 标签

# 请求示例

# Shell

curl -X PUT http://{admin-site}/admin-api/socks5_proxy/{id}/user_groups/{id} -d
'{
    "label": "test",
    "id": 3,
    "name": "openresty"
}'

# 响应示例

Status: 200 OK
{
    "status": 0
}

# 删除用户组

# 简介

删除用户组。

# URI

DELETE /admin-api/socks5_proxy/{id}/user_groups/{id}

# 请求示例

# Shell

curl -X DELETE http://{admin-site}/admin-api/socks5_proxy/{id}/user_groups/{id}

# 响应示例

Status: 200 OK
{
    "status": 0
}