Health check API - SSO

In clustered environments one of load balancer's roles is to continuously probe the health of cluster's nodes in order to find out which nodes are up and running and which are down. Ubisecure SSO's health can be checked using the ping-interface, which can be accessed in address:

https://{sso-server address}/uas/ping

The health of the system is determined in the HTTP-return code:

  • 200 → System is ok and responsive.
  • 503 → Service unavailable, system is not ok.

Status 200 is returned if Tomcat responds to HTTP requests and Ubilogin Directory responds to LDAP queries. External database connections are not checked.

Note that in case status 503 is returned, the reason for the error is not specified in the return message.