Auth

Auth API

OAuth login and session status endpoints.

Notes

Login and callback routes issue redirects.

Session cookies are used for AUTH_USER flows.

GET /auth/github/login

Start GitHub OAuth login flow and redirect to provider.

Permission: PUBLIC

Query

NameTypeRequiredNotes
statestringNoOpaque state forwarded to provider.

Response

302 redirect
GET /auth/github/callback

Handle GitHub OAuth callback and finalize session.

Permission: PUBLIC

Query

NameTypeRequiredNotes
codestringYesAuthorization code from provider.
statestringNoForwarded state.

Response

Redirect handled by AuthService.
GET /auth/linuxdo/login

Start Linux.do OAuth login flow and redirect to provider.

Permission: PUBLIC

Query

NameTypeRequiredNotes
statestringNoOpaque state forwarded to provider.

Response

302 redirect
GET /auth/linuxdo/callback

Handle Linux.do OAuth callback and finalize session.

Permission: PUBLIC

Query

NameTypeRequiredNotes
codestringYesAuthorization code from provider.
statestringNoForwarded state.

Response

Redirect handled by AuthService.
GET /auth/logout

Clear session and redirect to configured frontend URL.

Permission: PUBLIC

Response

302 redirect to FRONTEND_LOGOUT_REDIRECT_URL (default /)
GET /auth/me

Return current authenticated user or an unauthenticated response.

Permission: PUBLIC Guard: AuthGuard

Response

{ "status": 200, "message": "OK", "data": { "provider": "github", "username": "user", "owner": true } } 401 format: { "status": 401, "message": "User is not authenticated.", "data": null }