Share:
ClickHelp Documentation

ClickHelp - Author, host and deliver documentation across platforms and devices!    Explore 200+ Features

You can log in to ClickHelp using  Google as the  OpenID Connect provider. Further on, you will find the steps of how to set up a Google Web Application and to configure your ClickHelp portal to use this OpenID Connect provider .

Setting up a Google Web Application a  

To set up the Google Web Application :

  • First of all, you need to register your ClickHelp portal as a web application in the Google Developer Console ( https://console.developers.google.com):

  • Click the Enable and manage APIs button to start binding Google OpenID Connect provider to your portal . Since you do not have a project in the GDC , you will be offered to create one:

  • Once a new project is created, click Credentials to continue setting up things.

  • On the Credentials screen, click the Add Credentials button and select the OAuth 2.0 client ID option.

  • The next step is giving a name to the web application you register in the GDC and set up what the Google login screen should show. To do this, first click the Configure consent screen button:

  • And then specify the application name, responsible person email address and, if needed, some other optional parameters.

  • When the name is set, you can generate the Client ID and Client Secret for the application. To do this, specify the application type as Web application, type the internal application name and specify the application authorized redirect URL. It must be this (a slash at the end is required):

    https://<YOU_PORTAL_NAME>.clickhelp.co/oauth2/

  • Google will generate the required Client ID and Secret for you:

  • Now, to proceed to the ClickHelp settings , we need to get the authentication and token URLs from Google . For this, click the Download button next to the newly created application name and download a JSON file containing all the required data.


Configuring ClickHelp a  

Now, let's set up ClickHelp to work with Google as OpenID Connect Provider . Follow these steps:

  • To make a ClickHelp portal work with an OpenID Connect Provider , we need to register a client for this provider in the portal. This can be done in the Portal Settings editor by a user with administrator permissions:
     
  • Open the Single Sign-on page under the Administration menu, select the predefined Google connection, specify Client ID and Client Secret obtained from Google earlier. Enable the connection and click Save to save the settings.
     
  • Once the provider client is saved, you may specify it as the default provider. To do this, select the client name in the Login with combo box.
     
    That’s it, the OpenID Connect functionality for Google is enabled in the portal!
  • If you want to continue using the ClickHelp login dialog, leave the Log with field untouched. You will be able to login to your portal using Google credentials from the Login dialog by clicking the corresponding button:

Using the Google OpenID Provider a  

To check how the automatic authentication via OpenID Connect works, we need to make sure that we have a user with email address corresponding to a valid Google account.

  • Let’s open the User Management page:
     
  • And add a new user with an address bound to a valid Google account :
     
  • Once the user is created, log out from your admin account or open a new instance of your browser in the Incognito mode. Also, please make sure that the test Google account is not logged in within this browser session. You can open the Google+ page to make sure that no Google accounts are logged in.

  • If you specified Google as the default login option, you can open an article from a restricted publication by a direct link which can be a link provided by your portal or application as a reference to a Help topic, FAQ article and so on. You will be automatically redirected to the Google account login page as we are not logged in to Google at the moment.


  • Once the valid credentials are provided, you are logged in to ClickHelp :
     

  • Now, log out from ClickHelp and try to open this page once again. Since you are logged in to Google in this browser session, ClickHelp will log in the user automatically without showing any login prompts.

    If you want the OpenID Connect provider to always show the login prompt, you can change the value of the Login behavior parameter to Require login prompt :
     

  • This time, if you are logged into Google , you still see the Google login prompt when logging into ClickHelp :

  • Even if you specified Google as the default login option, it is still possible to log in to a ClickHelp portal using its native credentials (ClickHelp user account, no SSO), you can do this by following this link:
    https://<YourPortalName>.clickhelp.co/login/?error=no&no-sso=true

Well done! You have successfully set up Google as the OpenID Connect provider for your online documentation portal.