Auth

GitHub OAuth authentication

Initiate GitHub OAuth login

get

Redirects the user to GitHub for OAuth authentication.

Responses

302

Redirect to GitHub OAuth

get

/api/auth/github

HTTPcURLJavaScriptPython

GET /api/auth/github HTTP/1.1
Host: backend.pvzm.net
Accept: */*

302

Redirect to GitHub OAuth

No content

GitHub OAuth callback

get

Handles the OAuth callback from GitHub. Redirects to /admin.html on success.

Query parameters

codestringOptional

Responses

302

Redirect to admin page on success

get

/api/auth/github/callback

HTTPcURLJavaScriptPython

GET /api/auth/github/callback HTTP/1.1
Host: backend.pvzm.net
Accept: */*

302

Redirect to admin page on success

No content

Check authentication status

get

Responses

200

Authentication status

application/json

or

get

/api/auth/status

HTTPcURLJavaScriptPython

GET /api/auth/status HTTP/1.1
Host: backend.pvzm.net
Accept: */*

200

Authentication status

{
  "authenticated": true,
  "user": {
    "username": "text",
    "displayName": "text",
    "profileUrl": "text",
    "avatarUrl": "text"
  }
}

Logout

get

Responses

200

Logged out successfully

No content

get

/api/auth/logout

HTTPcURLJavaScriptPython

GET /api/auth/logout HTTP/1.1
Host: backend.pvzm.net
Accept: */*

200

Logged out successfully

No content