HTTP Request Client IP Extractor
Description
Extract the client IP address of the incoming HTTP request. The client IP address is required by IAM in various
places, e.g. when writing log files.
May be used by
Properties
HTTP Header Name (
httpHeaderName) Description
HTTP header name whose value contains the IP address.
The HTTP header name must be identical to the configured HTTP header name on the proxy in front of IAM. HTTP header names are case-insensitive. The first header matching this configuration is processed. If the header value has multiple coma-separated IP addresses the first value is considered. If no matching header or no valid IP address is found, the IP address of the request source is used.
The HTTP header name consists of any visible ASCII characters except: "(),/:;<=>?@[\]{}".
Attributes
String
Optional
Validation RegEx: [a-zA-Z0-9!#$%&'*+\-.^_`|~]+
Default value
X-Forwarded-For
Example
X-Forwarded-For
Example
X-Client-IP
Ignore Private IP Addresses (
ignorePrivateIpAddresses) Description
Whether private IP addresses should be ignored or not.
The X-Forwarded-For header may contain multiple comma-separated IP addresses of proxies before IAM. Public and private IP addresses are allowed in this header. When this option is:
- checked: the first public IP address is used. Potential private IP addresses before the public IP address are ignored.
- unchecked: the first public or private IP address is used.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)
type: ClientIpExtractor
id: ClientIpExtractor-xxxxxx
displayName:
comment:
properties:
httpHeaderName: X-Forwarded-For
ignorePrivateIpAddresses: false