Modbot Docs

Get current user

GET/api/auth/me

Who the session belongs to. The SPA calls this on load to decide what to show: the sign-in form, the link-your-VRChat-account page, or the app. Reachable before the VRChat link is done, because it is how the SPA finds out the link is not done.

Called with an API key, apiKey names the key and lists what it may do right now, which is what every request with it is checked against: its own permissions, never more than the account holds. permissionNames beside it are the account's. Null for a session.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/api/auth/me"
{  "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.