Use OAuth to Authenticate Users

OAuth is an open-standard authorization protocol that's used by many organizations to authenticate individuals and provide Single Sign-on (SSO).

We support authentication with OAuth 2.0 and your organization's Google account.


To use OAuth authentication with Google, follow these steps:

  1. Open your coreserver.properties file.

    To edit coreserver.properties from the Dashboard, go to Maintenance > Configuration Properties, then follow the folder structure config > server > bin and click on the file coreserver.properties. You can then edit the properties directly from the Dashboard.

    If you're a Standard Stack user, you can edit coreserver.properties from the configuration directory: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties

  2. Add the following properties:

    dashboard.loginMode=authToken
    authentication.useExternal=true
    authentication.external=oauth
    authentication.external.oauth.provider=google
    authentication.external.oauth.clientId=<CLIENT_ID_FROM_OAUTH_SERVICE_PROVIDER>
    authentication.external.oauth.clientSecret=<CLIENT_SECRET_FROM_OAUTH_SERVICE_PROVIDER>
    authentication.external.oauth.callbackUrl=<ACROLINX_URL>/dashboard/api/oauth/callback

    The following example uses authentication with Google:

    dashboard.loginMode=authToken
    authentication.useExternal=true
    authentication.external=oauth
    authentication.external.oauth.provider=google
    authentication.external.oauth.clientId=12345678901234567890
    authentication.external.oauth.clientSecret=09876543210987654321
    authentication.external.oauth.callbackUrl=http://acrolinx.instance.com/dashboard/api/oauth/callback
  3. Save your changes and restart the core server.