2.9.2. 用户配置接口

2.9.2.1. user 获取用户设置

GET /api/config/user

请求参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识

返回示例

{
  "id": 0,
  "username": "admin",
  "isAdmin": true
}

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
username	String	(必需)用户名
isAdmin	Bool	(必需)是否有管理员权限
roles	String[]	非管理员用户的功能角色列表（页面权限）。未返回代表未设置。

2.9.2.2. users 获取所有用户设置

此接口无请求参数。

GET /api/config/users

返回示例

[
  {
    "id": 0,
    "username": "admin",
    "isAdmin": true
  },
  {
    "id": 1,
    "username": "user1",
    "isAdmin": false
  }
]

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
username	String	(必需)用户名
isAdmin	Bool	(必需)是否有管理员权限
roles	String[]	非管理员用户的功能角色列表（页面权限）。未返回代表未设置。

2.9.2.3. create-user 创建新用户

未提供密码时，新用户的初始密码与用户名相同。

POST /api/config/create-user

请求体示例 application/json

{
  "username": "user2",
  "isAdmin": false
}

请求参数	类型	说明
username	String	(必需)用户名
isAdmin	Bool	是否有管理员权限，默认为 true。
roles	String[]	非管理员用户的功能角色列表（页面权限）。未提供代表不设置。
password	String	初始密码，未提供时默认与用户名相同。响应中不会返回密码。

返回示例

{
  "id": 2,
  "username": "user2",
  "isAdmin": false
}

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
username	String	(必需)用户名
isAdmin	Bool	(必需)是否有管理员权限
roles	String[]	非管理员用户的功能角色列表（页面权限）。未返回代表未设置。

2.9.2.4. update-user 修改用户设置

修改用户名时，密码不会被修改。

POST /api/config/update-user

请求体示例 application/json

{
  "id": 2,
  "username": "user2",
  "isAdmin": false
}

请求参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
username	String	用户名，默认不修改。
isAdmin	Bool	是否有管理员权限，默认不修改；但当该用户是系统中最后一个管理员时，必须显式传入 `isAdmin: true`，否则返回 INVALID_CONFIG_SETTING（At least one admin.）。
roles	String[]	非管理员用户的功能角色列表（页面权限）。默认不修改。

返回示例

{
  "id": 2,
  "username": "user2",
  "isAdmin": false
}

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
username	String	(必需)用户名
isAdmin	Bool	(必需)是否有管理员权限
roles	String[]	非管理员用户的功能角色列表（页面权限）。未返回代表未设置。

2.9.2.5. delete-user 删除用户

GET /api/config/delete-user

请求参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识

返回示例

{
  "errorCode": 0,
  "errorMsg": "Success"
}

返回参数	类型	说明
errorCode	Int32	(必需)错误码，0 代表成功。
errorMsg	String	(必需)错误内容

2.9.2.6. user-security 获取用户安全设置

GET /api/config/user-security

请求参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识

返回示例

{
  "id": 2,
  "secretKey": "sk-XXXXXXXXXX",
  "authorizedApis": "prefix,/cnc;prefix,/db;prefix,/analysis;prefix,/group-analysis;prefix,/config;prefix,/core;prefix,/gateway;prefix,/auth;"
}

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
secretKey	String	密钥，以 “sk-” 前缀开头。未返回代表未设置。
authorizedApis	String	授权 API，即用户可以使用的 API，未返回代表未设置。API 命令格式参考 API 命令格式。

2.9.2.7. update-user-security 修改用户安全设置

POST /api/config/update-user-security

请求体示例 application/json

{
  "id": 2,
  "secretKey": "sk-XXXXXXXXXX",
  "authorizedApis": "prefix,/cnc;prefix,/db;prefix,/analysis;prefix,/group-analysis;prefix,/config;prefix,/core;prefix,/gateway;prefix,/auth;"
}

请求参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
secretKey	String	密钥，以 “sk-” 前缀开头。密钥在所有用户间必须唯一，重复时返回 GENERAL_CONFIG_DUPLICATE_VALUE（Secret key already exists.）。
authorizedApis	String	授权 API，即用户可以使用的 API，未返回代表未设置。API 命令格式参考 API 命令格式。

返回示例

{
  "id": 2,
  "secretKey": "sk-XXXXXXXXXX",
  "authorizedApis": "prefix,/cnc;prefix,/db;prefix,/analysis;prefix,/group-analysis;prefix,/config;prefix,/core;prefix,/gateway;prefix,/auth;"
}

返回参数	类型	说明
id	Int32	(必需)数据库标识，详见 1.1.4. ID 数据库标识
secretKey	String	密钥，以 “sk-” 前缀开头。未返回代表未设置。
authorizedApis	String	授权 API，即用户可以使用的 API，未返回代表未设置。API 命令格式参考 API 命令格式。

扫码添加微信客服