Skip to main content
Version: 57.2.0

addGitHubAuthRoutes

addGitHubAuthRoutes(app, userModel, githubOptions, authOptions?): void

Adds GitHub OAuth routes to the Express application.

Routes added:

  • GET /auth/github - Initiates GitHub OAuth flow
  • GET /auth/github/callback - Handles GitHub OAuth callback
  • POST /auth/github/link - Links GitHub account to authenticated user (requires JWT auth)
  • DELETE /auth/github/unlink - Unlinks GitHub account from authenticated user (requires JWT auth)

Parameters

app

Application

userModel

UserModel

githubOptions

GitHubAuthOptions

authOptions?

AuthOptions

Returns

void