Enabling Health Check Endpoints - Identity and Access Management Services - 4.2 - 4.2 - Public - Other - external

Identity and Access Management Services

Identity and Access Management Services

You must configure the appsettings.json file in the Hyland IdP server to enable the health check endpoints.

To enable health check endpoints for Hyland IdP:

  1. Open the appsettings.json file of the Hyland IdP server in a plain-text editor. In a default installation, this file is located at C:\Program Files\Hyland\identityprovider\config
  2. Locate the HealthChecks section and check the value of the "Enabled" flag.
    Note: The default value of the "Enabled" flag is true. You will receive the health status of Hyland IdP only when the "Enabled" flag is true.
  3. Optional. Configure the values in the sub-section, "DetailedEndpointAuthorization". The "DetailedEndpointAuthorization" flag consists of the following three key-value pairs:
    1. "EndpointEnabled": Set to true to receive detailed information on the health status. Default value is false.
    2. "RequireKey": Check the value of "RequireKey". Default value is true. When "RequireKey" is true, you must establish a designated "StaticKey" and include it in the authorization header to access the detailed status. However, if "RequireKey" is false, you do not need to pass any static key in your request's authorization header.
    3. "StaticKey": Set any alpha-numeric value as a static key.
      Note: We recommend using a static key as the health status details might include sensitive information.