/api/users
Perform various actions on users, or retrieve all the users in the database.
Info
This endpoint requires authentication.
Info
This endpoint requires administrator priviliges or higher.
GET Request
Query Parameters
| Name | Type | Description |
|---|---|---|
noincl | 'true'|'false' | If 'true', exclude the current authenticated user from results. |
Response
Status: 200 OK
Content-Type: application/json
An array of users in the database.
Example
[{"id": "cmb6042f500029kenox2u8npu","username": "admin","createdAt": "2025-05-27T04:13:22.625Z","updatedAt": "2025-05-27T04:13:22.689Z","role": "SUPERADMIN","view": {},"oauthProviders": [],"totpSecret": null,"passkeys": [],"quota": null,"sessions": ["QSmGQUAjHBQCCdn7p6YfIOuAR24ZTNIL"],"avatar": null}]
POST Request
Create a new user.
Body
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
username | string | Required. Username for the new user. |
password | string | Required. Password for the new user. |
avatar | string?~ | Base64 avatar image, or uses default if not provided. |
role | 'USER' | 'ADMIN'?~ | Role to assign (USER or ADMIN). Defaults to USER. |
Example
{"username": "test","password": "test","avatar": "data:image/png;base64,stuff...","role": "USER"}
Response
Status: 200 OK
Content-Type: application/json
Returns a User object representing the newly created user.
Example
{"id": "cmb618zts00059ken21a6uenw","username": "hello","createdAt": "2025-05-27T04:45:12.160Z","updatedAt": "2025-05-27T04:45:12.160Z","role": "USER","view": {},"oauthProviders": [],"quota": null,"sessions": []}
Error Responses
-
400 Bad Request
If the request body is invalid or missing required fields.
-
403 Forbidden
If the setup has already been completed.
Errors
All errors are formatted as JSON objects with the following structure....
/api/users/:id
Get a specific user by their ID, and make changes to their user.
Last updated: 6/1/2025
Edit this page on GitHub