Google OAuth2

Follow these steps to configure Google Cloud Platform (GCP) as an authentication provider for your application:

1. Create a New Project

1. Go to the Google Cloud Console and log in with your Google account.

2. In the top navigation bar, click on Select a project.

   

3. In the “Select a project” modal, click on the New project button located at the top right.

   

4. On the “New Project” page, enter a Project name (e.g., AIV Google Provider).

   

5. Click on the Create button.

2. Configure the OAuth Consent Screen

1. Once your project is created and selected, navigate to the Google Auth Platform or APIs & Services > Credentials from the left-hand menu.

   

2. If this is your first time configuring the consent screen for this project, you will see a “Google Auth Platform not configured yet” message. Click on the Get started button.

3. In the Project configuration > App Information section, provide the following details:

   • App name: Enter a name for your application (e.g., AIV Google Provider Test). This is the name users will see when they are asked to grant permissions.

   • User support email: Select a support email address from the dropdown list.

     

4. Click on the Next button to proceed to the Audience step.

5. In the Audience step, select External and click on the Next button.

   

6. In the Contact Information step, enter an email address (e.g., aivhub1989@gmail.com) for Google to notify you about any changes to your project, then click Next.

   

7. In the Finish step, check the box to agree to the Google API Services: User Data Policy, click Continue, and then click on the Create button.

   

8. You will be redirected to the OAuth Overview page, where you should see a success message indicating the OAuth configuration is created.

   

3. Create OAuth Client

1. On the OAuth Overview page, click on the Create OAuth client button.

2. On the Create OAuth client ID page, configure the following:

   • Application type: Select Web application from the dropdown.

   • Name: Enter a name for the client (e.g., AIV Google Provider Web Client).

     

3. Scroll down to the Authorized redirect URIs section.

4. Click on the + Add URI button.

5. Enter the callback URL for your AIV instance (e.g., http(s)://<your_domain_name>/oauth/callback/google).

6. Click on the Create button at the bottom of the page to finalize the creation of your OAuth client.

   

7. A dialog will appear confirming the OAuth client was created. It displays your Client ID and Client secret. Make sure to copy and securely store the Client secret now, as you will not be able to view it again after closing this dialog. Click OK to close the dialog.

8. After closing the dialog, you will be taken to the Clients tab where you can see your newly created OAuth 2.0 Client ID listed.

   

4. Configure Authentication in AIV

1. Log in to your AIV application.

2. Click on the Hamburger menu (three horizontal lines) in the top-left corner to open the sidebar.

3. Expand the Administration section and click on Authentication.

   

4. The Universal Auth Administration page will open. From the left-hand directory menu, select Providers.

5. Under the Add provider section, locate the Provider type dropdown. By default, it will be set to Database (already configured).

6. Click the dropdown and select Google OAuth2.

7. Fill in the following details for the new provider:

   • Provider name: Google (or your preferred name)

   • Make sure to check the box for Enabled (show OAuth button on login).

     

8. Scroll down to the OAuth2 application section and fill in the following details:

   • Client ID: Paste the Client ID generated from your Google OAuth client.
   • Client secret: Paste the Client Secret you securely stored earlier.
   • Redirect URI: Enter the callback URL for your AIV instance (e.g., http(s)://<your_domain_name>/oauth/callback/google).

     • Note: This must exactly match the Authorized redirect URI you added in the Google Cloud Console.

       

9. Click on the Add Provider button.

10. A success popup message will appear, and you will now see your newly created Google authentication provider listed as Active in the Provider configuration list.

    

5. Test Google Authentication

1. Log out of your AIV application.

2. Navigate to the AIV login screen. You will now see a Sign in with Google button.

3. Click on the button to initiate the sign-in process via Google.

   

4. You will be redirected to the Google sign-in page. Choose your Google account to continue.

5. Review the permissions on the consent screen and click Continue.

6. Upon successful authentication, you will be redirected back to the AIV dashboard.