Skip to main content

GET /api/users

获取所有用户的列表。

GET /api/users/:username

获取特定用户的详细信息。

POST /api/users

创建新用户。

PUT /api/users/:username

更新现有用户。

DELETE /api/users/:username

删除用户。

GET /api/users-stats

获取有关用户及其服务器访问权限的统计信息。

获取所有用户

检索系统中所有用户的列表。
  • 端点: /api/users
  • 方法: GET
  • 身份验证: 必需(仅管理员)
  • 响应:

获取用户

检索特定用户的详细信息。
  • 端点: /api/users/:username
  • 方法: GET
  • 身份验证: 必需(仅管理员)
  • 参数:
    • :username (字符串, 必需): 用户的用户名。
  • 响应:

创建用户

在系统中创建新用户。
  • 端点: /api/users
  • 方法: POST
  • 身份验证: 必需(仅管理员)
  • 请求正文:
    • username (字符串, 必需): 新用户的用户名。
    • password (字符串, 必需): 新用户的密码。至少 6 个字符。
    • role (字符串, 可选): 用户的角色。可以是 "admin""user"。默认为 "user"
    • servers (字符串数组, 可选): 用户可以访问的服务器名称列表。
    • groups (字符串数组, 可选): 用户所属的组 ID 列表。

更新用户

更新现有用户的信息。
  • 端点: /api/users/:username
  • 方法: PUT
  • 身份验证: 必需(仅管理员)
  • 参数:
    • :username (字符串, 必需): 要更新的用户的用户名。
  • 请求正文:
    • password (字符串, 可选): 用户的新密码。
    • role (字符串, 可选): 用户的新角色。
    • servers (字符串数组, 可选): 更新的可访问服务器列表。
    • groups (字符串数组, 可选): 更新的组列表。

删除用户

从系统中删除用户。
  • 端点: /api/users/:username
  • 方法: DELETE
  • 身份验证: 必需(仅管理员)
  • 参数:
    • :username (字符串, 必需): 要删除的用户的用户名。

获取用户统计信息

检索有关用户及其对服务器和组的访问权限的统计信息。
  • 端点: /api/users-stats
  • 方法: GET
  • 身份验证: 必需(仅管理员)
  • 响应:
注意: 所有用户管理端点都需要管理员身份验证。