basePath: /api definitions: api.AddressBookForm: properties: data: example: '{"tags":["tag1","tag2","tag3"],"peers":[{"id":"abc","username":"abv-l","hostname":"","platform":"Windows","alias":"","tags":["tag1","tag2"],"hash":"hash"}],"tag_colors":"{\"tag1\":4288585374,\"tag2\":4278238420,\"tag3\":4291681337}"}' type: string type: object api.AuditConnForm: properties: action: type: string conn_id: type: integer id: type: string ip: type: string peer: items: type: string type: array session_id: type: number type: type: integer uuid: type: string type: object api.AuditFileForm: properties: id: type: string info: type: string is_file: type: boolean path: type: string peer_id: type: string type: type: integer uuid: type: string type: object api.DeviceInfoInLogin: properties: name: type: string os: type: string type: type: string type: object api.LoginForm: properties: autoLogin: type: boolean deviceInfo: $ref: '#/definitions/api.DeviceInfoInLogin' id: type: string password: maxLength: 32 minLength: 4 type: string type: type: string username: maxLength: 32 minLength: 2 type: string uuid: type: string required: - username type: object api.LoginRes: properties: access_token: type: string secret: type: string tfa_type: type: string type: type: string user: $ref: '#/definitions/api.UserPayload' type: object api.PeerForm: properties: cpu: type: string hostname: type: string id: type: string memory: type: string os: type: string username: type: string uuid: type: string version: type: string type: object api.UserPayload: properties: email: type: string info: additionalProperties: true type: object is_admin: type: boolean name: type: string note: type: string status: type: integer type: object model.AddressBookCollection: properties: created_at: type: string id: type: integer name: type: string updated_at: type: string user_id: type: integer required: - name type: object model.Tag: properties: collection: $ref: '#/definitions/model.AddressBookCollection' collection_id: type: integer color: description: color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, 可以转成rgba type: integer created_at: type: string id: type: integer name: type: string updated_at: type: string user_id: type: integer type: object model.TagList: properties: list: items: $ref: '#/definitions/model.Tag' type: array page: type: integer page_size: type: integer total: type: integer type: object response.DataResponse: properties: data: {} total: type: integer type: object response.ErrorResponse: properties: error: type: string type: object response.Response: properties: code: type: integer data: {} message: type: string type: object info: contact: {} description: 接口 title: 管理系统API version: "1.0" paths: /: get: consumes: - application/json description: 首页 produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 首页 tags: - 首页 /ab: get: consumes: - application/json description: 地址列表 produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 地址列表 tags: - 地址 post: consumes: - application/json description: 地址更新 parameters: - description: 地址表单 in: body name: body required: true schema: $ref: '#/definitions/api.AddressBookForm' produces: - application/json responses: "200": description: "null" schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 地址更新 tags: - 地址 /ab/peer/add/{guid}: delete: consumes: - application/json description: 删除地址 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 删除地址 tags: - 地址[Personal] post: consumes: - application/json description: 添加地址 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 添加地址 tags: - 地址[Personal] /ab/peer/update/{guid}: put: consumes: - application/json description: 更新地址 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 更新地址 tags: - 地址[Personal] /ab/peers: post: consumes: - application/json description: 地址 parameters: - description: 页码 in: query name: current type: integer - description: 每页数量 in: query name: pageSize type: integer - description: guid in: query name: ab type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 地址列表 tags: - 地址[Personal] /ab/personal: post: consumes: - application/json description: 个人地址 parameters: - description: string valid in: body name: string schema: type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 个人地址 tags: - 地址[Personal] /ab/settings: post: consumes: - application/json description: 设置 parameters: - description: string valid in: body name: string schema: type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 设置 tags: - 地址[Personal] /ab/shared/profiles: post: consumes: - application/json description: 共享 parameters: - description: 页码 in: query name: current type: integer - description: 每页数量 in: query name: pageSize type: integer produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 共享地址簿 tags: - 地址[Personal] /ab/tag/{guid}: delete: consumes: - application/json description: 标签 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 标签删除 tags: - 地址[Personal] /ab/tag/add/{guid}: post: consumes: - application/json description: 标签 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 标签添加 tags: - 地址[Personal] /ab/tag/rename/{guid}: put: consumes: - application/json description: 标签 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 标签重命名 tags: - 地址[Personal] /ab/tag/update/{guid}: put: consumes: - application/json description: 标签 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 标签修改颜色 tags: - 地址[Personal] /ab/tags/{guid}: post: consumes: - application/json description: 标签 parameters: - description: guid in: path name: guid required: true type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/model.TagList' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 标签 tags: - 地址[Personal] /audit/conn: post: consumes: - application/json description: 审计连接 parameters: - description: 审计连接 in: body name: body required: true schema: $ref: '#/definitions/api.AuditConnForm' produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 审计连接 tags: - 审计 /audit/file: post: consumes: - application/json description: 审计文件 parameters: - description: 审计文件 in: body name: body required: true schema: $ref: '#/definitions/api.AuditFileForm' produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 审计文件 tags: - 审计 /currentUser: get: consumes: - application/json description: 用户信息 produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/api.UserPayload' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - token: [] summary: 用户信息 tags: - 用户 /device-group/accessible: get: consumes: - application/json description: 机器 parameters: - description: 页码 in: query name: page type: integer - description: 每页数量 in: query name: pageSize type: integer - description: 状态 in: query name: status type: integer - description: accessible in: query name: accessible type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.DataResponse' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 设备 tags: - 群组 /heartbeat: post: consumes: - application/json description: 心跳 produces: - application/json responses: "200": description: OK "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 心跳 tags: - 首页 /login: post: consumes: - application/json description: 登录 parameters: - description: 登录表单 in: body name: body required: true schema: $ref: '#/definitions/api.LoginForm' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/api.LoginRes' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: 登录 tags: - 登录 /login-options: get: consumes: - application/json description: 登录选项 produces: - application/json responses: "200": description: OK schema: items: type: string type: array "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: 登录选项 tags: - 登录 /logout: post: consumes: - application/json description: 登出 produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: 登出 tags: - 登录 /oauth/callback: get: consumes: - application/json description: OauthCallback produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/api.LoginRes' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: OauthCallback tags: - Oauth /oidc/auth: post: consumes: - application/json description: OidcAuth produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/api.LoginRes' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: OidcAuth tags: - Oauth /oidc/auth-query: get: consumes: - application/json description: OidcAuthQuery produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/api.LoginRes' "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: OidcAuthQuery tags: - Oauth /peers: get: consumes: - application/json description: 机器 parameters: - description: 页码 in: query name: page type: integer - description: 每页数量 in: query name: pageSize type: integer - description: 状态 in: query name: status type: integer - description: accessible in: query name: accessible type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.DataResponse' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - BearerAuth: [] summary: 机器 tags: - 群组 /server-config: get: consumes: - application/json description: 服务配置,给webclient提供api-server produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - token: [] summary: 服务配置 tags: - WEBCLIENT /server-config-v2: get: consumes: - application/json description: 服务配置,给webclient提供api-server produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' security: - token: [] summary: 服务配置 tags: - WEBCLIENT_V2 /shared-peer: post: consumes: - application/json description: 分享的peer produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 分享的peer tags: - WEBCLIENT /sysinfo: post: consumes: - application/json description: 提交系统信息 parameters: - description: 系统信息表单 in: body name: body required: true schema: $ref: '#/definitions/api.PeerForm' produces: - application/json responses: "200": description: SYSINFO_UPDATED,ID_NOT_FOUND schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: 提交系统信息 tags: - System /sysinfo_ver: post: consumes: - application/json description: 获取系统版本信息 produces: - application/json responses: "200": description: OK schema: type: string "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' summary: 获取系统版本信息 tags: - System /users: get: consumes: - application/json description: 用户列表 parameters: - description: 页码 in: query name: page type: integer - description: 每页数量 in: query name: pageSize type: integer - description: 状态 in: query name: status type: integer - description: accessible in: query name: accessible type: string produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/response.DataResponse' - properties: data: items: $ref: '#/definitions/api.UserPayload' type: array type: object "500": description: Internal Server Error schema: $ref: '#/definitions/response.ErrorResponse' security: - BearerAuth: [] summary: 用户列表 tags: - 群组 /version: get: consumes: - application/json description: 版本 produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/response.Response' "500": description: Internal Server Error schema: $ref: '#/definitions/response.Response' summary: 版本 tags: - 首页 securityDefinitions: BearerAuth: in: header name: Authorization type: apiKey token: in: header name: api-token type: apiKey swagger: "2.0"