Start a session
POST
/api/auth/loginThe username field takes an email address or a username; both are matched case-insensitively.
Returns 401 for any failed attempt without saying why. Distinguishing "no such user" from "wrong password" would turn the login form into a way to enumerate staff accounts, and answering differently for an address would turn it into a way to find out who has an account here.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/auth/login" \ -H "Content-Type: application/json" \ -d '{ "username": "string", "password": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "username": "string", "permissions": 0, "permissionNames": [ "string" ], "roles": [ "string" ], "vrChatLinked": true, "vrChatUserId": null, "vrChatDisplayName": null, "email": null, "discordUserId": null, "discordUsername": null, "discordProven": true, "discordWorksUntil": null, "chatOn": true, "rank": null, "briefsOn": false, "apiKey": null, "getsEventInvites": true, "pinnedPages": null}