Manual · 9

Auth & user endpoints

Method Path Description
POST /auth/login Log in (see Authentication)
POST /auth/logout Log out
GET /auth/me Fetch own user
GET /auth/setup-status Checks whether initial setup is still pending (public). Response { "needs_setup", "manual_available", "demo_available" } – the last two tell whether handbook and demo data can be installed (only while needs_setup is true)
POST /auth/setup Create the first admin account (only if no user exists yet, public). Body { "username", "password", "manual": true, "demo": false } – manual (missing = true) installs the handbook, demo the demo data, see Setup. Response 201 with the user plus manual_installed/demo_installed. Option not available: 400 manual_unavailable/demo_unavailable (nothing is created). Installing failed: 500 manual_install_failed/demo_install_failed – account and session stay
GET /auth/tokens List your own API tokens
POST /auth/tokens Create a new API token (value shown only once)
DELETE /auth/tokens/{id} Revoke an API token
POST /auth/users/{id}/password Change your own password
GET /auth/users List all users (admin)
POST /auth/users Create a user (admin)
PATCH /auth/users/{id} Edit a user (admin)
DELETE /auth/users/{id} Delete a user (admin)
GET /auth/users/{id}/groups Groups of a user
GET /auth/users/{id}/table-permissions Table permissions of a user (admin)
PUT /auth/users/{id}/table-permissions Set table permissions (admin)