Configuring HTTP correlation ID support - PingDirectory

Page created: 26 Jul 2021 |

Page updated: 14 Jan 2022

| 1 min read

9.0 Product PingDirectory Directory Capability Product documentation Content Type Administration User task IT Administrator Administrator Audience System Administrator Software Deployment Method Configuration

Correlation ID support is enabled by default for each HTTP Connection Handler.

To enable or disable correlation ID support for the HTTPS Connection Handler, use the set-connection-handler-prop option with dsconfig.
This example shows how to enable correlation ID support.
```
$ dsconfig set-connection-handler-prop \
  --handler-name "HTTPS Connection Handler" \
  --set use-correlation-id-header:true
```
This example shows how to disable correlation ID support.
```
$ dsconfig set-connection-handler-prop \
  --handler-name "HTTPS Connection Handler" \
  --set use-correlation-id-header:false
```
To customize the response header name for the correlation ID, use the set-connection-handler-prop option with dsconfig.

Note:
The server generates a correlation ID for every HTTP request and sends it in the response through the Correlation-Id response header.
This example changes the correlation-id-response-header property value to X-Request-Id.
```
$ dsconfig set-connection-handler-prop \
   --handler-name "HTTPS Connection Handler" \
   --set correlation-id-response-header:X-Request-Id
```
To designate the names of one or more HTTP request headers that contain an existing correlation ID value, use the set-connection-handler-prop option with dsconfig.

Note:
This enables the server to integrate with a larger system consisting of every servers using correlation IDs.

By default, the server generates a new, unique correlation ID for each HTTP request and ignores any correlation ID that might be set on the request.
```
$ dsconfig set-connection-handler-prop --handler-name "HTTPS Connection Handler" \
  --set correlation-id-request-header:X-Request-Id \
  --set correlation-id-request-header:X-Correlation-Id \
  --set correlation-id-request-header:Correlation-Id \
  --set correlation-id-request-header:X-Amzn-Trace-Id
```