Difference between revisions of "Configuring Sign-In using Google"

From WHMCS Documentation

m
(Configuring Sign-In with Google)
Line 4: Line 4:
  
 
== Configuring Sign-In with Google ==
 
== Configuring Sign-In with Google ==
 
<html><a href="https://vimeo.com/236651329" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
 
  
 
Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.
 
Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.
Line 12: Line 10:
  
 
# Visit <tt>https://console.developers.google.com/</tt>.
 
# Visit <tt>https://console.developers.google.com/</tt>.
# Log in to your Google account. <div class="docs-alert-warning">Changing the Google account you use to create the app requires users to re-authenticate and re-link their accounts.</div>
+
# Log in to your Google account. <div class="docs-alert-warning">Changing the Google account you use to create the app requires users to reauthenticate and relink their accounts.</div>
# Choose '''Create project'''. [[File:Googlesignin1.png]]
+
# Choose '''Select a  project''' on the top menu.<br/>[[File:Google-sign-in-1.png|600px]]<br/><br/>
# Enter a project name and click '''Create'''. [[File:Googlesignin2.png]]
+
# Choose '''New Project'''.<br/>[[File:Google-sign-in-2.png|600px]]<br/><br/>
# On the project dashboard, select '''Credentials''' in the left sidebar.[[File:Googlesignin3.png]]
+
# Enter a project name.<br/>[[File:Google-sign-in-3.png|600px]]<br/><br/>
# For the '''OAuth consent screen''' configuration, enter a product name, homepage URL, and logo URL.
+
# Click '''Create'''.
# Click '''Save'''. [[File:Googlesignin4.png]]
+
# Choose '''Go to APIs overview'''.<br/>[[File:Google-sign-in-4.png|600px]]<br/><br/>
# Go back to the ''Credentials'' tab and select '''Create credentials > OAuth client ID'''. [[File:Googlesignin5.png]]
+
# Select '''Credentials''' in the left sidebar.
# Choose '''Web application'''. <br/>[[File:Googlesignin6.png]]
+
# Choose '''Create Credentials'''.<br/>[[File:Google-sign-in-5.png|600px]]<br/><br/>
# Enter your full root domain in both the authorized JavaScript origin and redirect URI boxes.
+
# Select '''OAuth client ID'''.
# Click '''Create'''. [[File:Googlesignin7.png]]
+
# Click '''Configure Consent Screen'''.
# Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS. [[File:Googlesignin8.png]]
+
# Select '''External'''.<br/>[[File:Google-sign-in-6.png|600px]]<br/><br/>
 +
# Click '''Create'''.
 +
# Add app information details.<br/>[[File:Google-sign-in-7.png|600px]]<br/><br/>
 +
# Add an app domain.<br/>[[File:Google-sign-in-8.png|600px]]<br/><br/>
 +
# Add authorised domains.<br/>[[File:Google-sign-in-9.png|600px]]<br/><br/>
 +
# Add developer contact information.<br/>[[File:Google-sign-in-10.png|600px]]<br/><br/>
 +
# Click '''Save and Continue'''.
 +
# Select '''Credentials''' in the left sidebar.
 +
# Choose '''Create Credentials'''.
 +
# Select '''OAuth client ID'''.
 +
# Choose '''Web Application'''.<br/>[[File:Google-sign-in-11.png|600px]]<br/><br/>
 +
# Enter a name for your OAuth 2.0 client.
 +
# Enter your full root domain in '''Authorized JavaScript origins'''.<br/>[[File:Google-sign-in-12.png|600px]]<br/><br/>
 +
# Enter your full root domain in '''Authorized redirect URI'''.<br/>[[File:Google-sign-in-13.png|600px]]<br/><br/>
 +
# Click '''Create'''.
 +
# Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS. <br/>[[File:Google-sign-in-14.png|600px]]<br/><br/>
 
# Log in to the WHMCS Admin Area.
 
# Log in to the WHMCS Admin Area.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Sign-In Integrations''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Sign-In Integrations''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
 
# Select '''Activate''' under the Google heading.
 
# Select '''Activate''' under the Google heading.
# Enter your Google client ID and secret.
+
# Enter your Google Client ID and Client Secret.
 
# Click '''Save & Activate'''.
 
# Click '''Save & Activate'''.
  

Revision as of 14:34, 24 March 2022

Enabling the Google Sign-In Integrations enables visitors and customers to register, sign in, and connect their Google accounts with your WHMCS installation for faster signup and automatic sign-in.

Signinintegrationslogin.png

Configuring Sign-In with Google

Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.

To do this:

  1. Visit https://console.developers.google.com/.
  2. Log in to your Google account.
    Changing the Google account you use to create the app requires users to reauthenticate and relink their accounts.
  3. Choose Select a project on the top menu.
    Google-sign-in-1.png

  4. Choose New Project.
    Google-sign-in-2.png

  5. Enter a project name.
    Google-sign-in-3.png

  6. Click Create.
  7. Choose Go to APIs overview.
    Google-sign-in-4.png

  8. Select Credentials in the left sidebar.
  9. Choose Create Credentials.
    Google-sign-in-5.png

  10. Select OAuth client ID.
  11. Click Configure Consent Screen.
  12. Select External.
    Google-sign-in-6.png

  13. Click Create.
  14. Add app information details.
    Google-sign-in-7.png

  15. Add an app domain.
    Google-sign-in-8.png

  16. Add authorised domains.
    Google-sign-in-9.png

  17. Add developer contact information.
    Google-sign-in-10.png

  18. Click Save and Continue.
  19. Select Credentials in the left sidebar.
  20. Choose Create Credentials.
  21. Select OAuth client ID.
  22. Choose Web Application.
    Google-sign-in-11.png

  23. Enter a name for your OAuth 2.0 client.
  24. Enter your full root domain in Authorized JavaScript origins.
    Google-sign-in-12.png

  25. Enter your full root domain in Authorized redirect URI.
    Google-sign-in-13.png

  26. Click Create.
  27. Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS.
    Google-sign-in-14.png

  28. Log in to the WHMCS Admin Area.
  29. Navigate to Configuration () > System Settings > Sign-In Integrations or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  30. Select Activate under the Google heading.
  31. Enter your Google Client ID and Client Secret.
  32. Click Save & Activate.

WHMCS will attempt to validate the details you have entered. If the client ID and secret are valid and successfully authenticate with the Google API, the values will be saved.

For troubleshooting help, please refer to Troubleshooting Sign-In using Google