Skip to content

Authenticating Kudos Boards with HCL Connections

Outcome

Register OAuth

In order for Kudos Boards to authenticate with your Connections environment, you must define a new OAuth widget.


  1. SSH to the HCL Connections Deployment Manager (substitute the alias)

    ssh root@[DEPLOY_MANAGER_ALIAS]
    
  2. Start wsadmin (substiture your credentials)

    cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin/
    ./wsadmin.sh -lang jython -username connectionsadmin -password passw0rd
    
  3. Register the new application definition

    execfile('oauthAdmin.py')
    OAuthApplicationRegistrationService.addApplication('kudosboards', 'Kudos Boards', 'https://kudosboards.com/auth/connections/[CONNECTIONS_HOSTNAME_BASE64]/callback')
    

    Where [CONNECTIONS_HOSTNAME_BASE64]is

    • your Connections hostname base64 encoded. E.g.
      connections.example.com => Y29ubmVjdGlvbnMuZXhhbXBsZS5jb20=
      There are many free online services to do this, ie here

  4. To view the uniquely created client clientSecret

    OAuthApplicationRegistrationService.getApplicationById('kudosboards')
    

    These commands will print the definition. Please take note of the clientSecret. We will use this later on as

    CONNECTIONS_URL=https://connections.example.com
    CONNECTIONS_CLIENT_ID=kudosboards
    CONNECTIONS_CLIENT_SECRET=[VALUE_PRINTED]
    

Configure Auto Auth

Steps to configure the Kudos Boards application for auto-authorize (also documented here)

Note: this step is optional but recommended and can be done at any time.

  1. Add the new line to the following section in [cellname]/oauth20/connectionsProvider.xml

    <parameter name="oauth20.autoauthorize.clients" type="ws" customizable="true">
      <value>kudosboards</value>
    </parameter>
    

    Note: keep any existing values and add the new line for kudosboards

  2. Recreate the provider via this command:

    ./wsadmin.sh -lang jython -conntype SOAP -c "print AdminTask.createOAuthProvider('[-providerName connectionsProvider -fileName  [PATH_TO_CONFIG_FILE]/oauth20/connectionsProvider.xml]')" -user connectionsadmin -password passw0rd
    

    Note: update the wsadmin credentials and the [PATH_TO_CONFIG_FILE]

  3. Restart the WebSphere servers