#9 Finished documentation

master
Keith Irwin 2023-04-12 22:06:51 -06:00
parent 2eb2f4e5aa
commit 2ed8597e94
Signed by: ki9
GPG Key ID: DF773B3F4A88DA86
1 changed files with 25 additions and 8 deletions

View File

@ -175,14 +175,31 @@ The admin API has no authentication so it should be blocked to all except admin
- `404`: Peer not found
- `500`: Other server error
#### 2.2.4. List users
#### 2.2.4. Add user
TODO
- **REQUEST:** `POST /user`
- **FILE:** `back/lib/admin/user/add`
- **QUERYSTRING:** `?t=$token&host=$hostname&user=$username`
- `t`: The token from a GET request
- `host`: The hostname chosen for the new peer
- `user`: The username chosen
- **RESPONSE:**
- `202`: Added
- `400`: Invalid input
- `403`: Bad token
- `409`: Username already taken
- `500`: Error
#### 2.2.5. Add user
#### 2.2.5. Delete user
TODO
#### 2.2.6. Delete user
TODO
- **REQUEST:** `DELETE /user`
- **FILE:** `back/lib/admin/user/del`
- **QUERYSTRING:** `?t=$token&user=$username&un=$usernumber`
- `t`: The token from a GET request
- `user`: The username to delete
- `un`: The user's subnet number
- **RESPONSE:**
- `202`: Deleted
- `400`: Bad username or number
- `403`: Bad token
- `500`: Other server error