Modbot Docs

Start a session

POST/api/auth/login

The 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}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.