Google Auth Module

Google authentication module allows users to log in to CodeCanvas with their Google credentials: email address and password.

Enable Google authentication

The setup is performed in four steps, on the both CodeCanvas and Google sides:

Get a Redirect URI from CodeCanvas. This URI is generated by CodeCanvas to identify the source of each login request to Google.
Enable Google People API.
Using the Redirect URI, generate a Client ID and Secret in the Google API Manager. Every login request sent from CodeCanvas to Google includes a unique identifier. The ID and secret you store in the authentication module tell Google 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 in the Google API Manager, provide these values to CodeCanvas and enable the Google 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 Google.
Copy the redirect URI that is displayed on the form under the Client ID field.
Click the link to access the Google API Manager. It will open in a new browser tab.
Log in to your Google account (if not already). The Google API Manager page will open.

On the Google API Manager page, select or create a project.
On the left, select Credentials.
From the Create credentials list, select OAuth client ID.
- The Create client ID page opens.
Click the Configure consent screen button.
On the OAuth consent screen page, enter a product name (CodeCanvas) and click the Save button.
- You're redirected to the Create client ID page.
For the Application type, select Web application.
- Additional input fields for defining the client ID are shown.
In the Authorized redirect URIs field, paste the redirect URI you copied from the Google Auth Module page in CodeCanvas.
Click the Create button.
- Google generates the credentials (client ID and secret) you need and displays them in a pop-up window.

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

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.
Client ID	Stores the identifier Google uses to validate a login request. This value is generated in the Google 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 Google API Manager along with the client ID.
User registration	On — Accounts in CodeCanvas will be created automatically for unregistered users who log in using Google authentication module. Off — Google logins will be only available to users who already have an account in CodeCanvas.
Restrict authentication to users with email addresses from the specified domains	When enabled, only the users with email addresses from the domain(s) you specified will be able to log in. Specify one or more allowed domains, e.g. `@gmail.com` or `@mycompany.com`.

Last modified: 28 August 2024