API reference
HTTP endpoints exposed by BeaconAuth.
Base paths
The API is served at:
/v1/*(direct)/api/v1/*(when mounted under/api)
Core endpoints
Sessions
POST /v1/loginPOST /v1/registerPOST /v1/refreshPOST /v1/logoutGET /v1/user/meGET /v1/user/me/avatarPOST /v1/user/change-passwordPOST /v1/user/change-usernamePOST /v1/user/profile
Example: POST /v1/login
{
"username": "player123",
"password": "secure_password"
}Minecraft authentication
POST /v1/minecraft-jwt
Example request:
{
"challenge": "PKCE_challenge_string",
"redirect_port": 38125
}OAuth
POST /v1/oauth/startPOST /v1/oauth/link/startGET /v1/oauth/callback
Passkeys (WebAuthn)
POST /v1/passkey/register/startPOST /v1/passkey/register/finishPOST /v1/passkey/auth/startPOST /v1/passkey/auth/finishPOST /v1/passkey/deleteGET /v1/passkey/listDELETE /v1/passkey/{id}
Identities
GET /v1/identitiesDELETE /v1/identities/{id}
Configuration and JWKS
GET /v1/configGET /.well-known/jwks.json
Admin
POST /v1/admin/migrations/up
Notes
- Session endpoints set HttpOnly cookies for access/refresh tokens.
- JWTs are signed with ES256 and published via JWKS.
- Some endpoints require an authenticated session.