Users API

Get User List

GET /api/auth/search

Query Param

The parameters here are URL Query parameters, which are presented in JSON format for better illustration.

{
  userName?: string
  page: number
  page_size: number
  role?: string      // User permission
                     // 1=User, 10=Admin, -1=Banned user
}

Response

{
  "status": 200,
  "data": {
    "data": [
      {
        "uuid": "55a8120adb4f4bb3bee672ef305bae62",
        "userName": "Admin",
        "passWord": "",
        "passWordType": 1,
        "salt": "",
        "permission": 10, // 1=User, 10=Admin, -1=Banned user
        "registerTime": "10/28/2023, 5:38:44 PM",
        "loginTime": "10/14/2023, 1:01:58 AM",
        // List of instances owned by the user
        "instances": [
          {
            "instanceUuid": "82e856fd33424e018fc2c007e1a3c4d3",
            "daemonId": "1fcdacc01eac44a7bf8fe83d34215d05"
          }
        ],
        "apiKey": "",
        "isInit": false,
        "secret": "",
        "open2FA": false
      }
    ],
    "maxPage": 1,
    "page": 1,
    "pageSize": 20,
    "total": 6
  },
  "time": 1718594177859
}

Create User

POST /api/auth

Request Body

{
  "username": string,
  "password": string,
  "permission": number  // 1=User, 10=Admin, -1=Banned user
}

Response

{
  "status": 200,
  "time": 1718594177859,
  "data": {
    "uuid": "046afc351bfb44a99aa5641c06e70e5a", // new user's uuid
    "userName": "Admin", // new user's username
    "permission": 1 // new user's permission
  }
}

Update User

PUT /api/auth

Request Body

{
  "uuid": string, // UUID of the target user
  "config": {
    // target user info
    "uuid": string,
    "userName": string,
    "loginTime": string,
    "registerTime": string,
    "instances": InstanceDetail[],  // user instances
                                    // You can assign instances to users here
    "permission": number,  // 1=User, 10=Admin, -1=Banned user
    "apiKey": string,
    "isInit": boolean,
    "secret": string,
    "open2FA": boolean,
  }
}

For information about InstanceDetail, see this

Response

{
  "status": 200,
  "data": true,
  "time": 1718594177859
}

Delete User

DELETE /api/auth

Request Body

["user uuid"]; // UUID of the target users

Response

{
  "status": 200,
  "data": true,
  "time": 1718594177859
}