The health status of each dependency determines the overall health status of Hyland IdP. The list below displays some sample requests and responses when health check endpoints are configured for Hyland IdP.
-
“/diagnostics”, under the condition of a new installation, without
the application’s initialization, and considering all the default values. The
following response is displayed:
-
“/diagnostics/details”, under the condition of a new installation,
without the application’s initialization, and considering all the default
values. The following response is displayed:
-
“/diagnostics/details”, under the condition when a static key is
present in the authorization header. For
example:
"HealthChecks": { "Enabled": true, "DetailedEndpointAuthorization": { "EndpointEnabled": false, "RequireKey": true, "StaticKey": "********" } }The following response is displayed:
{ "status": "Unhealthy", "version": "4.1.0", "totalDuration": "173.5426 ms", "results": [ { "status": "Unhealthy", "description": "Invalid connection string.", "entry": "Operational Database", "duration": "170.6445 ms" } ] }This response contains information such as, dependency status, the IdP version, the total time taken to create a response, the time taken by dependencies to ascertain their status, and a description of why the dependency is considered unhealthy.
-
“/diagnostics”, after the application’s initialization.
The following response is displayed:
-
“/diagnostics/details”, after the application’s initialization. In
this example, Hyland SCIM is configured. The following response is
displayed:
{ "status": "Healthy", "version": "4.1.0", "totalDuration": "34.7295 ms", "results": [ { "status": "Healthy", "description": "Operational Database is healthy and ready to use.", "entry": "Operational Database", "duration": "15.7044 ms" }, { "status": "Healthy", "description": "The SCIM Service has been loaded successfully.", "entry": "SCIM Service", "duration": "16.0504 ms" } ] }Note: Hyland IdP does not depend on Hyland SCIM if it is not configured. -
“/diagnostics/details”, under the condition when SCIM service is
unreachable. The following response is
displayed:
{ "status": "Unhealthy", "version": "4.1.0", "totalDuration": "4086.158 ms", "results": [ { "status": "Healthy", "description": "Operational Database is healthy and ready to use.", "entry": "Operational Database", "duration": "8.6327 ms" }, { "status": "Unhealthy", "message": "No connection could be made because the target machine actively refused it. (localhost:5009)", "entry": "SCIM Service", "duration": "4077.4565 ms" } ] } -
“/diagnostics/details”, after configuring provider. Note: This endpoint only checks the status of SAML provider.
The following response is displayed:
{ "status": "Healthy", "version": "4.1.0", "totalDuration": "221.3856 ms", "results": [ { "status": "Healthy", "description": "Operational Database is healthy and ready to use.", "entry": "Operational Database", "duration": "174.6909 ms" }, { "status": "Healthy", "description": "The SCIM Service has been loaded successfully.", "entry": "SCIM Service", "duration": "9.216 ms" }, { "status": "Healthy", "description": "simpleSAML Service is healthy and loaded successfully.", "entry": "simpleSAML", "duration": "34.6251 ms" } ] } -
“/diagnostics/details”, when the SAML provider is unreachable. The
following response is dispayed:
{ "status": "Unhealthy", "version": "4.1.0", "totalDuration": "4150.2282 ms", "results": [ { "status": "Healthy", "description": "Operational Database is healthy and ready to use.", "entry": "Operational Database", "duration": "44.5473 ms" }, { "status": "Healthy", "description": "The SCIM Service has been loaded successfully.", "entry": "SCIM Service", "duration": "3.5958 ms" }, { "status": "Unhealthy", "description": "Failed to connect with simpleSAML Service. Metadata is Invalid. No connection could be made because the target machine actively refused it. [::ffff:127.0.0.1]:5098 (localhost:5098)", "entry": "simpleSAML", "duration": "4102.0104 ms" } ] }