2.2.2.1 client-request-id

  • Article

The client-request-id HTTP header is optional and MAY be specified by the client role of the ADFSOAL Protocol. This header is used to provide the server role a unique request ID, which is then used by the server of the ADFSOAL Protocol to log error messages that were encountered while processing that lookup request. The value of the client-request-id HTTP header MUST be a globally unique identifier (GUID) in standard string representation (see [C706] section 3.1.17 (String UUID) for the format).

Note The client-request-id HTTP header and the client-request-id query parameter defined in section 2.2.3.2 are designed to be mutually exclusive. The client role of the ADFSOAL Protocol SHOULD use either the HTTP header or the query parameter. If both are specified, the server role of the ADFSOAL Protocol gives precedence to the client-request-id query parameter and ignores the value of the client-request-id HTTP header.

The format for the client-request-id HTTP header is as follows.

 String = *(%x20-7E)
 client-request-id = String