Files
rustdesk-api/docs/admin/admin_swagger.json
T
thomasandClaude Opus 4.8 16e97c8efa i18n: Translate all Chinese to English across the codebase
Translate Chinese comments, log/error messages, validator labels and
Swagger annotations to English throughout the source code, generated
Swagger docs, config files and CI workflows.

Make the English README primary: README.md now holds the English docs
and README_EN.md holds the Chinese version, with cross-language links
updated accordingly.

Note: the generated docs/ swagger files were translated in place; run
`go generate ./...` (swag init) to regenerate them from the now-English
annotations when a Go toolchain is available.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:17:04 +02:00

6592 lines
216 KiB
JSON

{
"swagger": "2.0",
"info": {
"description": "API",
"title": "management systemAPI",
"contact": {},
"version": "1.0"
},
"basePath": "/api",
"paths": {
"/admin/address_book/batchCreate": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch create address books",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "batch create address books",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "create address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "delete address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "address book details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "address book list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/share": {
"post": {
"security": [
{
"token": []
}
],
"description": "share address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "share address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.ShareByWebClientForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book"
],
"summary": "edit address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book name"
],
"summary": "create address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book name"
],
"summary": "delete address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book name details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book name"
],
"summary": "address book name details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book name list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book name"
],
"summary": "address book name list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollectionList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book name"
],
"summary": "edit address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection_rule/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book rules"
],
"summary": "create address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection_rule/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book rules"
],
"summary": "delete address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection_rule/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book rule details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book rules"
],
"summary": "address book rule details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection_rule/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book rule list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book rules"
],
"summary": "address book rule list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
},
{
"type": "integer",
"description": "address book collectionid",
"name": "collection_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollectionList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/address_book_collection_rule/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"address book rules"
],
"summary": "edit address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_conn/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete connection logs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"connection log"
],
"summary": "batch delete connection logs",
"parameters": [
{
"description": "connection log",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AuditConnLogIds"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_conn/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete connection log",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"connection log"
],
"summary": "delete connection log",
"parameters": [
{
"description": "connection log info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AuditConn"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_conn/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "connection log list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"connection log"
],
"summary": "connection log list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "target device",
"name": "peer_id",
"in": "query"
},
{
"type": "integer",
"description": "source device",
"name": "from_peer",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AuditConnList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_file/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete file logs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"file log"
],
"summary": "batch delete file logs",
"parameters": [
{
"description": "file log",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AuditFileLogIds"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_file/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete file log",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"file log"
],
"summary": "delete file log",
"parameters": [
{
"description": "file log info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AuditFile"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/audit_file/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "file log list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"file log"
],
"summary": "file log list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "target device",
"name": "peer_id",
"in": "query"
},
{
"type": "integer",
"description": "source device",
"name": "from_peer",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AuditFileList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/config/admin": {
"get": {
"security": [
{
"token": []
}
],
"description": "ADMINservice config",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"ADMIN"
],
"summary": "ADMINservice config",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/config/app": {
"get": {
"security": [
{
"token": []
}
],
"description": "APPservice config",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"ADMIN"
],
"summary": "APPservice config",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/config/server": {
"get": {
"security": [
{
"token": []
}
],
"description": "service config, provides an api-server for the webclient",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"ADMIN"
],
"summary": "RUSTDESKservice config",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/device_group/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create device group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device group"
],
"summary": "create device group",
"parameters": [
{
"description": "device group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.DeviceGroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.DeviceGroup"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/device_group/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete device group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device group"
],
"summary": "delete device group",
"parameters": [
{
"description": "group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.DeviceGroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/device_group/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "device group details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device group"
],
"summary": "device group details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Group"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/device_group/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "group list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "group list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.GroupList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/device_group/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit device group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device group"
],
"summary": "edit device group",
"parameters": [
{
"description": "group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.DeviceGroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Group"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/file/oss_token": {
"get": {
"security": [
{
"token": []
}
],
"description": "getossToken",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"file"
],
"summary": "getossToken",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/file/upload": {
"post": {
"security": [
{
"token": []
}
],
"description": "upload file to local",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"file"
],
"summary": "upload file to local",
"parameters": [
{
"type": "file",
"description": "file upload example",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/group/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "create group",
"parameters": [
{
"description": "group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.GroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Group"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/group/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "delete group",
"parameters": [
{
"description": "group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.GroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/group/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "group details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "group details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Group"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/group/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "group list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "group list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.GroupList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/group/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit group",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"group"
],
"summary": "edit group",
"parameters": [
{
"description": "group info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.GroupForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Group"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/login": {
"post": {
"security": [
{
"token": []
}
],
"description": "login",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login"
],
"summary": "login",
"parameters": [
{
"description": "login info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/github_com_lejianwen_rustdesk-api_v2_http_request_admin.Login"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/admin.LoginPayload"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/login-options": {
"post": {
"description": "login options",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login"
],
"summary": "login options",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.ErrorResponse"
}
}
}
}
},
"/admin/login_log/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete login logs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login log"
],
"summary": "batch delete login logs",
"parameters": [
{
"description": "login log",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.LoginLogIds"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/login_log/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete login log",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login log"
],
"summary": "delete login log",
"parameters": [
{
"description": "login log info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.LoginLog"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/login_log/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "login log details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login log"
],
"summary": "login log details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.LoginLog"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/login_log/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "login log list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login log"
],
"summary": "login log list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "userID",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.LoginLogList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/logout": {
"post": {
"description": "logout",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login"
],
"summary": "logout",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book"
],
"summary": "create address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book"
],
"summary": "delete address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book"
],
"summary": "address book list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book"
],
"summary": "edit address book",
"parameters": [
{
"description": "address book info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.AddressBookForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBook"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book name"
],
"summary": "create address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book name"
],
"summary": "delete address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book name list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book name"
],
"summary": "address book name list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollectionList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book name",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book name"
],
"summary": "edit address book name",
"parameters": [
{
"description": "address book name info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection_rule/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book rules"
],
"summary": "create address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection_rule/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book rules"
],
"summary": "delete address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection_rule/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "address book rule list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book rules"
],
"summary": "address book rule list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
},
{
"type": "integer",
"description": "address book collectionid",
"name": "collection_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollectionList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/address_book_collection_rule/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit address book rule",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my address book rules"
],
"summary": "edit address book rule",
"parameters": [
{
"description": "address book rule info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.AddressBookCollectionRule"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.AddressBookCollection"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/login_log/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete login logs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my login logs"
],
"summary": "batch delete login logs",
"parameters": [
{
"description": "login log",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.LoginLogIds"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/login_log/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete login log",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my login logs"
],
"summary": "delete login log",
"parameters": [
{
"description": "login log info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.LoginLog"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/login_log/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "login log list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my login logs"
],
"summary": "login log list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "userID",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.LoginLogList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/peer/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "device list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my devices"
],
"summary": "device list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "time",
"name": "time_ago",
"in": "query"
},
{
"type": "string",
"description": "ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "hostname",
"name": "hostname",
"in": "query"
},
{
"type": "string",
"description": "uuids separated by commas",
"name": "uuids",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.PeerList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/share_record/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete my share records",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my "
],
"summary": "batch delete my share records",
"parameters": [
{
"description": "id",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerShareRecordBatchDeleteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/share_record/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete share record",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my share records"
],
"summary": "delete share record",
"parameters": [
{
"description": "share record info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.ShareRecordForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/share_record/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "share record list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my share records"
],
"summary": "share record list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/tag/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my tags"
],
"summary": "create tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Tag"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/tag/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "delete tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/tag/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "tag list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my tags"
],
"summary": "tag list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.TagList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/my/tag/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"my tags"
],
"summary": "edit tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Tag"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oauth/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "createOauth",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "createOauth",
"parameters": [
{
"description": "Oauthinfo",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.OauthForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Oauth"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oauth/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "Oauthdelete",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "Oauthdelete",
"parameters": [
{
"description": "Oauthinfo",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.OauthForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oauth/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "Oauthdetails",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "Oauthdetails",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Oauth"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oauth/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "Oauthlist",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "Oauthlist",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.OauthList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oauth/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "Oauthedit",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "Oauthedit",
"parameters": [
{
"description": "Oauthinfo",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.OauthForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.OauthList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/oidc/auth": {
"post": {
"description": "OidcAuth",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "OidcAuth",
"responses": {}
}
},
"/admin/oidc/auth-query": {
"get": {
"description": "OidcAuthQuery",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Oauth"
],
"summary": "OidcAuthQuery",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/admin.LoginPayload"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete devices",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "batch delete devices",
"parameters": [
{
"description": "deviceid",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerBatchDeleteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create device",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "create device",
"parameters": [
{
"description": "device info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Peer"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete device",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "delete device",
"parameters": [
{
"description": "device info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "device details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "device details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Peer"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "device list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "device list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "time",
"name": "time_ago",
"in": "query"
},
{
"type": "string",
"description": "ID",
"name": "id",
"in": "query"
},
{
"type": "string",
"description": "hostname",
"name": "hostname",
"in": "query"
},
{
"type": "string",
"description": "uuids separated by commas",
"name": "uuids",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.PeerList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/peer/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit device",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"device"
],
"summary": "edit device",
"parameters": [
{
"description": "device info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Peer"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/share_record/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch share records",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"share record"
],
"summary": "batch share records",
"parameters": [
{
"description": "id",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.PeerShareRecordBatchDeleteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/share_record/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete share record",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"share record"
],
"summary": "delete share record",
"parameters": [
{
"description": "share record info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.ShareRecordForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/share_record/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "share record list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"share record"
],
"summary": "share record list",
"parameters": [
{
"type": "integer",
"description": "userID",
"name": "user_id",
"in": "query"
},
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/tag/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "create tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Tag"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/tag/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "delete tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/tag/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "tag details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "tag details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Tag"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/tag/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "tag list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "tag list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "whether it is mine",
"name": "is_my",
"in": "query"
},
{
"type": "integer",
"description": "userid",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.TagList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/tag/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit tag",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"tag"
],
"summary": "edit tag",
"parameters": [
{
"description": "tag info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.TagForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.Tag"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/changeCurPwd": {
"post": {
"security": [
{
"token": []
}
],
"description": "change the current user's password",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "change the current user's password",
"parameters": [
{
"description": "user info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.ChangeCurPasswordForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/create": {
"post": {
"security": [
{
"token": []
}
],
"description": "create administrator",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "create administrator",
"parameters": [
{
"description": "administrator info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.UserForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.User"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/current": {
"get": {
"security": [
{
"token": []
}
],
"description": "current user",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "current user",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/admin.LoginPayload"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete administrator",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "delete administrator",
"parameters": [
{
"description": "user info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.UserForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/detail/{id}": {
"get": {
"security": [
{
"token": []
}
],
"description": "administrator details",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "administrator details",
"parameters": [
{
"type": "integer",
"description": "ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.User"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "administrator list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "administrator list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "account",
"name": "username",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.UserList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/myOauth": {
"get": {
"security": [
{
"token": []
}
],
"description": "my authorizations",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "my authorizations",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/admin.UserOauthItem"
}
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/update": {
"post": {
"security": [
{
"token": []
}
],
"description": "edit administrator",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "edit administrator",
"parameters": [
{
"description": "user info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.UserForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.User"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user/updatePassword": {
"post": {
"security": [
{
"token": []
}
],
"description": "change password",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "change password",
"parameters": [
{
"description": "user info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.UserPasswordForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user_token/batchDelete": {
"post": {
"security": [
{
"token": []
}
],
"description": "batch delete login credentials",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login credential"
],
"summary": "batch delete login credentials",
"parameters": [
{
"description": "login credential info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/admin.UserTokenBatchDeleteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user_token/delete": {
"post": {
"security": [
{
"token": []
}
],
"description": "delete login credential",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login credential"
],
"summary": "delete login credential",
"parameters": [
{
"description": "login credential info",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.UserToken"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/response.Response"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
},
"/admin/user_token/list": {
"get": {
"security": [
{
"token": []
}
],
"description": "login credential list",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"login credential"
],
"summary": "login credential list",
"parameters": [
{
"type": "integer",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "page size",
"name": "page_size",
"in": "query"
},
{
"type": "integer",
"description": "userID",
"name": "user_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/response.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/model.UserTokenList"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Response"
}
}
}
}
}
},
"definitions": {
"admin.AddressBookForm": {
"type": "object",
"required": [
"id"
],
"properties": {
"alias": {
"type": "string"
},
"collection_id": {
"type": "integer"
},
"forceAlwaysRelay": {
"type": "boolean"
},
"hash": {
"type": "string"
},
"hostname": {
"type": "string"
},
"id": {
"type": "string"
},
"loginName": {
"type": "string"
},
"online": {
"type": "boolean"
},
"password": {
"type": "string"
},
"platform": {
"type": "string"
},
"rdpPort": {
"type": "string"
},
"rdpUsername": {
"type": "string"
},
"row_id": {
"type": "integer"
},
"sameServer": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "integer"
},
"user_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"username": {
"type": "string"
}
}
},
"admin.AuditConnLogIds": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"admin.AuditFileLogIds": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"admin.ChangeCurPasswordForm": {
"type": "object",
"required": [
"new_password",
"old_password"
],
"properties": {
"new_password": {
"type": "string",
"maxLength": 32,
"minLength": 4
},
"old_password": {
"type": "string",
"maxLength": 32,
"minLength": 4
}
}
},
"admin.DeviceGroupForm": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"admin.GroupForm": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "integer"
}
}
},
"admin.LoginLogIds": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"admin.LoginPayload": {
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"email": {
"type": "string"
},
"nickname": {
"type": "string"
},
"route_names": {
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"admin.OauthForm": {
"type": "object",
"required": [
"client_id",
"client_secret",
"oauth_type"
],
"properties": {
"auto_register": {
"type": "boolean"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"id": {
"type": "integer"
},
"issuer": {
"type": "string"
},
"oauth_type": {
"type": "string"
},
"op": {
"type": "string"
},
"pkce_enable": {
"type": "boolean"
},
"pkce_method": {
"type": "string"
},
"scopes": {
"type": "string"
}
}
},
"admin.PeerBatchDeleteForm": {
"type": "object",
"required": [
"row_ids"
],
"properties": {
"row_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"admin.PeerForm": {
"type": "object",
"properties": {
"cpu": {
"type": "string"
},
"group_id": {
"type": "integer"
},
"hostname": {
"type": "string"
},
"id": {
"type": "string"
},
"memory": {
"type": "string"
},
"os": {
"type": "string"
},
"row_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"uuid": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"admin.PeerShareRecordBatchDeleteForm": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"admin.ShareByWebClientForm": {
"type": "object",
"required": [
"id",
"password",
"password_type"
],
"properties": {
"expire": {
"type": "integer"
},
"id": {
"type": "string"
},
"password": {
"type": "string"
},
"password_type": {
"description": "can only be once,fixed",
"type": "string",
"enum": [
"once",
"fixed"
]
}
}
},
"admin.ShareRecordForm": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"user_id": {
"type": "integer"
}
}
},
"admin.TagForm": {
"type": "object",
"required": [
"color",
"name"
],
"properties": {
"collection_id": {
"type": "integer"
},
"color": {
"type": "integer"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
"admin.UserForm": {
"type": "object",
"required": [
"group_id",
"status",
"username"
],
"properties": {
"avatar": {
"type": "string"
},
"email": {
"description": "validate:\"required,email\" emailnot enforced",
"type": "string"
},
"group_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"is_admin": {
"type": "boolean"
},
"nickname": {
"description": "Password string `json:\"password\" validate:\"required,gte=4,lte=20\"`",
"type": "string"
},
"status": {
"minimum": 0,
"allOf": [
{
"$ref": "#/definitions/model.StatusCode"
}
]
},
"username": {
"type": "string",
"maxLength": 32,
"minLength": 2
}
}
},
"admin.UserOauthItem": {
"type": "object",
"properties": {
"op": {
"type": "string"
},
"status": {
"type": "integer"
}
}
},
"admin.UserPasswordForm": {
"type": "object",
"required": [
"id",
"password"
],
"properties": {
"id": {
"type": "integer"
},
"password": {
"type": "string",
"maxLength": 32,
"minLength": 4
}
}
},
"admin.UserTokenBatchDeleteForm": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"github_com_lejianwen_rustdesk-api_v2_http_request_admin.Login": {
"type": "object",
"required": [
"password",
"username"
],
"properties": {
"captcha": {
"type": "string"
},
"captcha_id": {
"type": "string"
},
"password": {
"type": "string"
},
"platform": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"model.AddressBook": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"collection": {
"$ref": "#/definitions/model.AddressBookCollection"
},
"collection_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"forceAlwaysRelay": {
"type": "boolean"
},
"hash": {
"type": "string"
},
"hostname": {
"type": "string"
},
"id": {
"type": "string"
},
"loginName": {
"type": "string"
},
"online": {
"type": "boolean"
},
"password": {
"type": "string"
},
"platform": {
"type": "string"
},
"rdpPort": {
"type": "string"
},
"rdpUsername": {
"type": "string"
},
"row_id": {
"type": "integer"
},
"sameServer": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"username": {
"type": "string"
}
}
},
"model.AddressBookCollection": {
"type": "object",
"required": [
"name"
],
"properties": {
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
"model.AddressBookCollectionList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.AddressBookCollection"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.AddressBookCollectionRule": {
"type": "object",
"required": [
"collection_id",
"rule",
"to_id",
"type"
],
"properties": {
"collection_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"rule": {
"description": "0: none 1: read 2: read-write 3: full control",
"type": "integer",
"maximum": 3,
"minimum": 1
},
"to_id": {
"type": "integer"
},
"type": {
"description": "1: personal 2: group",
"type": "integer",
"maximum": 2,
"minimum": 1
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
"model.AddressBookList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.AddressBook"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.AuditConn": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"close_time": {
"type": "integer"
},
"conn_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"from_name": {
"type": "string"
},
"from_peer": {
"type": "string"
},
"id": {
"type": "integer"
},
"ip": {
"type": "string"
},
"peer_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"type": {
"type": "integer"
},
"updated_at": {
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"model.AuditConnList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.AuditConn"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.AuditFile": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"from_name": {
"type": "string"
},
"from_peer": {
"type": "string"
},
"id": {
"type": "integer"
},
"info": {
"type": "string"
},
"ip": {
"type": "string"
},
"is_file": {
"type": "boolean"
},
"num": {
"type": "integer"
},
"path": {
"type": "string"
},
"peer_id": {
"type": "string"
},
"type": {
"type": "integer"
},
"updated_at": {
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"model.AuditFileList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.AuditFile"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.DeviceGroup": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"model.Group": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "integer"
},
"updated_at": {
"type": "string"
}
}
},
"model.GroupList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.Group"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.LoginLog": {
"type": "object",
"properties": {
"client": {
"description": "webadmin,webclient,app,",
"type": "string"
},
"created_at": {
"type": "string"
},
"device_id": {
"type": "string"
},
"id": {
"type": "integer"
},
"ip": {
"type": "string"
},
"is_deleted": {
"type": "integer"
},
"platform": {
"description": "windows,linux,mac,android,ios",
"type": "string"
},
"type": {
"description": "account,oauth",
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"user_token_id": {
"type": "integer"
},
"uuid": {
"type": "string"
}
}
},
"model.LoginLogList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.LoginLog"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.Oauth": {
"type": "object",
"properties": {
"auto_register": {
"type": "boolean"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"issuer": {
"type": "string"
},
"oauth_type": {
"type": "string"
},
"op": {
"type": "string"
},
"pkce_enable": {
"type": "boolean"
},
"pkce_method": {
"type": "string"
},
"scopes": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"model.OauthList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.Oauth"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.Peer": {
"type": "object",
"properties": {
"cpu": {
"type": "string"
},
"created_at": {
"type": "string"
},
"group_id": {
"type": "integer"
},
"hostname": {
"type": "string"
},
"id": {
"type": "string"
},
"last_online_ip": {
"type": "string"
},
"last_online_time": {
"type": "integer"
},
"memory": {
"type": "string"
},
"os": {
"type": "string"
},
"row_id": {
"type": "integer"
},
"updated_at": {
"type": "string"
},
"user": {
"$ref": "#/definitions/model.User"
},
"user_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"uuid": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"model.PeerList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.Peer"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.StatusCode": {
"type": "integer",
"enum": [
1,
2
],
"x-enum-comments": {
"COMMON_STATUS_DISABLED": "common status disable",
"COMMON_STATUS_ENABLE": "common status enable"
},
"x-enum-varnames": [
"COMMON_STATUS_ENABLE",
"COMMON_STATUS_DISABLED"
]
},
"model.Tag": {
"type": "object",
"properties": {
"collection": {
"$ref": "#/definitions/model.AddressBookCollection"
},
"collection_id": {
"type": "integer"
},
"color": {
"description": "color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color, can be converted to rgba",
"type": "integer"
},
"created_at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
"model.TagList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.Tag"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.User": {
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"created_at": {
"type": "string"
},
"email": {
"type": "string"
},
"group_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"is_admin": {
"type": "boolean"
},
"nickname": {
"type": "string"
},
"status": {
"$ref": "#/definitions/model.StatusCode"
},
"updated_at": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"model.UserList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.User"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"model.UserToken": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"device_id": {
"type": "string"
},
"device_uuid": {
"type": "string"
},
"expired_at": {
"type": "integer"
},
"id": {
"type": "integer"
},
"token": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "integer"
}
}
},
"model.UserTokenList": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/definitions/model.UserToken"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"response.ErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response.Response": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {},
"message": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"BearerAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"token": {
"type": "apiKey",
"name": "api-token",
"in": "header"
}
}
}