PingIDM

Server state

You can access information about the current state of the IDM instance through the info and health endpoints, as shown in the following table:

URI HTTP Operation Description

/openidm/info/features?_queryFilter=true

GET

Queries the available features in the server configuration.

The info/features endpoint is deprecated and will be removed in a future release of IDM.

/openidm/info/login

GET

Provides authentication and authorization details for the current user.

/openidm/info/ping

GET

Indicates the current server status. Possible states are STARTING,ACTIVE_READY, ACTIVE_NOT_READY, and STOPPING.

The info/ping endpoint is deprecated and will be removed in a future release of IDM. Use the openidm/health/live and openidm/health/ready endpoints instead.

/openidm/health

GET

Indicates the current server status. Possible states are STARTING,ACTIVE_READY, ACTIVE_NOT_READY, and STOPPING.

The openidm/health endpoint is deprecated and will be removed in a future release of IDM. Use the openidm/health/live and openidm/health/ready endpoints instead.

/openidm/health/live

GET

Checks if the IDM instance is running. Returns a 200 OK status if the required bundles are installed and started. Otherwise, it returns a 503 Service Unavailable status. This endpoint can be used as a liveness probe in containerized environments.

/openidm/health/ready

GET

Checks if the IDM instance is ready to accept traffic. Returns a 200 OK status if the required services are available. Otherwise, it returns a 503 Service Unavailable status. This endpoint can be used as a readiness probe in containerized environments.

/openidm/info/uiconfig

GET

Provides the UI configuration of this IDM instance. The language parameter returned is the user’s preferred language, based on the Accept-Language header included in the request. If Accept-Language is not specified in the request, it returns the language set in conf/ui-configuration.json.

/openidm/info/version

GET

Provides the software version of this IDM instance.