Skip to main content Skip to navigation


The SSOClient API is a new API designed specifically for SSOv3. It only deals with the process of logging in, logging out and getting logged in user information. It is NOT used to just get users by their usercodes statically, for this use the Userlookup API.

SSOClient consists of:

The sso-client.jar contains the following key java classes:

  • SSOClientFilter - the main class used to put in front of java apps that deals with all incoming requests
  • ShireServlet - a servlet that carries out the Shire functionality for the client application
  • LogoutServlet - a servlet that carries out the Logout functions for the client application

The sso.tld is simply a taglib that can be used to generate login and logout links.

The sso-config.xml is used to configure SSOClient on a per application basis.