How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I perform an anonymous health check on the IDM server (All versions)?

Last updated Apr 8, 2021

The purpose of this article is to provide information on performing an anonymous health check on the IDM server. Anonymous access may be required if you have an application or load balancer that needs to check the availability of the IDM instance but you don't want to provide any user credentials.


2 readers recommend this article

Performing anonymous health checks

Basic health checks can be performed against the info/ping endpoint to check that IDM is available.

To perform an anonymous health check, you must specifically include the following headers in your rest call to identify yourself as anonymous, else the call will fail:

X-OpenIDM-Password: anonymous X-OpenIDM-Username: anonymous

The anonymous user (internal/role/openidm-reg role) has access to the info/ping endpoint by default.

Example

To perform an anonymous health check, you would use a REST call such as the following:

  • IDM 7 and later: $ curl -H "X-OpenIDM-Username: anonymous" -H "X-OpenIDM-Password: anonymous" -H "Accept-API-Version: resource=1.0" -X GET "http://idm.example.com:8080/openidm/info/ping"
  • Pre-IDM 7: $ curl -H "X-OpenIDM-Username: anonymous" -H "X-OpenIDM-Password: anonymous" -X GET "http://idm.example.com:8080/openidm/info/ping"

Example response:

{ "_id" : "", "state" : "ACTIVE_READY", "shortDesc" : "OpenIDM ready" }

See Also

How does IDM (All versions) use anonymous access?

Installation Guide › Monitor Server Health

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.