Spaces:
Sleeping
Sleeping
File size: 4,691 Bytes
836f140 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# Authentication System API Documentation
## Base URL
```
/v1/api
```
## Authentication Routes
### 1. Sign Up
Creates a new user account.
**Endpoint:** `POST /auth/signup`
**Request Body:**
```json
{
"username": "string",
"password": "string",
"email": "string (optional)"
}
```
**Response (201 Created):**
```json
{
"message": "User created successfully"
}
```
**Possible Errors:**
- `400 Bad Request`: Username already exists
### 2. Login
Authenticates a user and creates a new session.
**Endpoint:** `POST /auth/login`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Request Body:**
```json
{
"username": "string",
"password": "string"
}
```
**Response (200 OK):**
```json
{
"user_id": "string",
"username": "string",
"email": "string",
"access_level": "string",
"date_joined": "datetime",
"access_token": "string",
"token_type": "bearer"
}
```
**Possible Errors:**
- `401 Unauthorized`: Invalid credentials
### 3. Logout
Terminates an active session.
**Endpoint:** `POST /auth/logout`
**Query Parameters:**
- `user_id`: string
- `token`: string
**Response (200 OK):**
```json
{
"message": "Session forcefully expired"
}
```
**Possible Errors:**
- `400 Bad Request`: No active sessions
### 4. Validate Token
Validates an existing session token.
**Endpoint:** `GET /auth/validate`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `user_id`: string
- `token`: string
**Response (200 OK):**
```json
{
"access_token": "string",
"token_type": "bearer"
}
```
**Possible Errors:**
- `401 Unauthorized`: No active sessions, Device mismatch, Token expired, Invalid token
### 5. Search Users
Search for users by username.
**Endpoint:** `GET /auth/search-users`
**Query Parameters:**
- `query`: string
**Response (200 OK):**
```json
[
"string"
]
```
### 6. Get User ID
Retrieve user ID by username.
**Endpoint:** `GET /auth/get-user-id`
**Query Parameters:**
- `username`: string
**Response (200 OK):**
```
"string" (user_id)
```
**Possible Errors:**
- `404 Not Found`: Username not found
### 7. Update Own Data
Update authenticated user's information.
**Endpoint:** `PUT /auth/user/update`
**Headers:**
- `token`: string
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `user_id`: string
**Request Body:**
```json
{
"password": "string (optional)",
"email": "string (optional)",
"username": "string (optional)"
}
```
**Response (200 OK):**
```json
{
"username": "string",
"email": "string",
"access_level": "string",
"date_joined": "datetime"
}
```
## Admin Routes
### 1. Get All Users
Retrieve all users (requires HUSH access level).
**Endpoint:** `GET /admin/users`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `user_id`: string (admin's user ID)
- `token`: string
**Response (200 OK):**
```json
[
{
"username": "string",
"email": "string",
"access_level": "string",
"date_joined": "datetime"
}
]
```
**Possible Errors:**
- `403 Forbidden`: Insufficient permissions
### 2. Get User Details
Retrieve specific user details (requires HUSH access level).
**Endpoint:** `GET /admin/user/{user_id}`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `admin_id`: string
- `token`: string
**Response (200 OK):**
```json
{
"username": "string",
"email": "string",
"access_level": "string",
"date_joined": "datetime"
}
```
### 3. Update User
Update user information (requires HUSH access level).
**Endpoint:** `PUT /admin/user/{user_id}`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `admin_id`: string
- `token`: string
**Request Body:**
```json
{
"password": "string (optional)",
"email": "string (optional)",
"username": "string (optional)"
}
```
### 4. Update Access Level
Update user access level (requires HUSH access level).
**Endpoint:** `PUT /admin/user/{user_id}/access-level`
**Headers:**
- `user-agent`: Browser/device user agent string (required)
**Query Parameters:**
- `admin_id`: string
- `token`: string
**Request Body:**
```json
{
"access_level": "string"
}
```
## Access Levels
The system supports the following access levels in ascending order of privileges:
1. `default`
2. `member`
3. `admin`
4. `dev`
5. `hush`
## Notes
- All timestamps are in UTC
- Token expiration is set to 60 minutes
- Sessions are device-specific and validated against the user agent
- Database changes are saved to disk in debug mode
- The system automatically creates a HUSH-level system user on startup |