The health check endpoint for Hyland IdP facilitates regular testing of the health status of Hyland IdP based its dependencies. This method also serves as an efficient monitoring tool that can promptly notify users of any malfunction.
Hyland IdP offers two endpoints for assessing its health status:
- /diagnostics: Informs whether Hyland IdP is healthy or unhealthy
- /diagnostics/details: Provides a detailed description of the health status of Hyland IdP
The table below displays the list of dependencies for Hyland IdP that are available for health check:
| Dependency | Condition |
|---|---|
| Operational Database | Always |
| SCIM Service | Only when SCIM Endpoint is configured |
| SAML Provider | Only when SAML provider is configured. For example, if five SAML providers are configured, then the response includes the health status of all the five SAML providers. |