ClickHelp Documentation

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

You can log in to ClickHelp using Azure Active Directory as an OpenID Connect provider. Further on, you will find the steps of how to configure this authentication mechanism in your ClickHelp portal.

  • Create a new Azure account.

  • You need a Microsoft account for this. Create one if you do not have it - it's free.

  • Once you have logged in using your Microsoft account, you will need to create an Azure tenant (portal). It’s free, but requires both phone and credit/debit card verification. 

  • Once you pass verification, wait for a couple of minutes until the account is created.

  • You are ready to start using Azure! Click Portal to open the new management portal for Azure.

  • Now, you need to register your ClickHelp portal as an application in your Azure’s Active Directory. To do this, open the Active Directory settings.
  • Click App registrations to open the list of registered applications.
  • Click Add and specify the application name, type (select Web app / API) and the sign-on URL (see next step).

  • Now, it’s time to open your ClickHelp portal and go to the SSO settings. Select the Azure client and find the value of the Redirect URL field. Use this value to register a new app in Azure AD on the previous step.
  • The application is added. Now, we need to get some details about it. Click the application name.

  • Click the Properties item and find the Application ID field. The value of this field is the Client ID needed to set up the OpenID Connect provider in ClickHelp. Copy it somewhere to use it later.

  • Now, we need to generate a key that will be our Client Secret value needed to register the provider in ClickHelp. To do this, click Keys in the application Settings.

  • Give a name to the new key, specify its duration and then save it. Once the key value appears on the screen, remember it. Please note that you will never be able to see this key again once you close the page. So be sure that the key is carefully saved somewhere.

  • The latest piece of information about the portal we need is to get the tenant id or domain name. To get it, return to the new management portal, click the Help icon and select Show diagnostics. In the opened JSON file, find the tenant ID or domain name values.
  • Populate the corresponding fields of the Azure client in ClickHelp with the values taken from Azure. For the discovery URL use the following value replacing the {ID_OR_NAME} placeholder either with the tenant id or with the domain name (whatever you like):{ID_OR_NAME}/.well-known/openid-configuration
    Enable the connection and save changes.
  • That’s all, you now can log in to your ClickHelp portal using Azure as an OpenID Connect provider.