Using the Monitoring Endpoint
You can use the monitoring endpoint to accurately monitor the health of HID Authentication Service platform from any monitoring tool.
Important: Only Client Credential Grant type bearer token must be used for this endpoint.
The request with bearer token is shown below:
Copy
The request with bearer token:
POST https://auth-eu.api.hidglobal.com/healthcheck
Authorization:Bearer CLIENT_CREDENTIAL_GRANT_TYPE_BEARER_TOKEN
Content-Type:application/x-www-form-urlencoded
tenantId: YOUR_TENANT_IDCopy
Response
{
"platformStatus": {
"idpService": {"status": "UP"},
"ScimService": {"status": "DOWN"},
"ConfigService": {"status": "SLOW"}
}
}The response provides the status of the individual services with three possible states:
“status”: “UP” - when there is a quick response (within three seconds)
“status”: “SLOW” - when there is a delay in response (if it took more than three seconds)
“status”: “DOWN” - when there is no response
Note: If the “idpService” status is down, “platformStatus” is also considered as down which means you will not get any response from other services such as “ScimService” and “ConfigService”.
