GitHub Auth Module

The GitHub authentication module allows users to log in to CodeCanvas with their GitHub account credentials: username and password.

Enable GitHub authentication

The setup is performed in three steps, on both CodeCanvas and GitHub sides:

Get a callback URL from CodeCanvas. This URL is generated by CodeCanvas to identify the source of each login request to GitHub.
Using the callback URL, generate a Client ID and Secret on GitHub. Every login request sent from CodeCanvas to GitHub includes a unique identifier. The ID and secret you store in the authentication module tell GitHub that each login request is authorized.
Provide the Client ID and Secret to CodeCanvas and enable the Auth Module. When you've generated the Client ID and Secret on GitHub, provide these values to CodeCanvas and enable the GitHub Auth Module.

Log in to CodeCanvas as a System Administrator.
In the header navigation, select Administration, then in the sidebar menu, select Auth Modules.
Click New auth module. The New Auth Module dialog opens.
From the Type list, select GitHub.
Copy the callback URL displayed on the form under the Client ID field.
Click the link to access the Register a new OAuth application page on GitHub (It will open in a new browser tab).
Log in to your GitHub account (if not already). The Register a new OAuth application page will open.

On the GitHub Register a new OAuth application page, specify the general parameters to register a new OAuth application:
- Application name (CodeCanvas)
- Homepage URL (The URL of your CodeCanvas instance)
- Application description (Optional)
In the Authorization callback URL field, paste the callback URL you copied from the GitHub Auth Module page in CodeCanvas.
Click the Register application button.
- GitHub generates the credentials (client ID and secret) you need and displays them in a pop-up window.

Copy the client ID from GitHub and paste it into the Client ID input field on the GitHub Auth Module form in CodeCanvas.
Copy the client secret from GitHub and paste it into the Client Secret input field on the GitHub Auth Module form in CodeCanvas.
Configure the optional settings for the authentication module.
Switch the module status to Active.
- The GitHub authentication module is enabled.
- The GitHub icon is added to the login dialog window. Users can click this icon to authenticate and log in to CodeCanvas with their GitHub credentials.

Setting	Description
Type	Name of the application or service that handles third-party authentication..
Status	Select Active to enable the module.
Key	A unique identifier of the module. Keep the default key or specify a new one.
Name	A human-readable name to distinguish this module from other authentication modules in the Auth Modules list. Keep the default name or enter a new one.
Server URL	The URL of the server (GitHub or GitHub Enterprise) to which CodeCanvas sends a login request for authentication when a user logs in with GitHub credentials.
Client ID	Stores the identifier GitHub uses to validate a login request. This value is generated in the GitHub API Manager when you configure the authorization settings for a web application and enter the redirect URI copied from CodeCanvas.
Client Secret	Stores the secret or password used to validate the client ID. This value is generated in the GitHub API Manager along with the client ID.
User registration	On — Accounts in CodeCanvas will be created automatically for unregistered users who log in using GitHub authentication module. Off — GitHub logins will be only available to users who already have an account in CodeCanvas.
Restrict authentication to users from the specified GitHub organizations	When selected, only the users from GitHub organizations you specified will be able to log in. Enter a comma-separated list of allowed organizations. If not selected, any user with a GitHub account can log in using this auth module.

Last modified: 28 August 2024