ProxyProtocolConfig

The configuration for the proxy.

JSON representation
{
  "allowedClientHeaders": [
    string
  ],
  "contextualHeaders": {
    object (ContextualHeaders)
  },
  "metadataHeaders": {
    string: string,
    ...
  },
  "gatewayIdentity": enum (GatewayIdentity),
  "clientIp": boolean
}
Fields
allowedClientHeaders[]

string

Optional. List of the allowed client header names.

contextualHeaders

object (ContextualHeaders)

Optional. Configuration for the contextual headers.

metadataHeaders

map (key: string, value: string)

Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110:

Field names can contain alphanumeric characters, hyphens, and periods, can contain only ASCII-printable characters and tabs, and must start with a letter.

gatewayIdentity

enum (GatewayIdentity)

Optional. The security gateway identity configuration.

clientIp

boolean

Optional. Client IP configuration. The client IP address is included if true.

ContextualHeaders

Contextual headers configuration.

JSON representation
{
  "userInfo": {
    object (DelegatedUserInfo)
  },
  "groupInfo": {
    object (DelegatedGroupInfo)
  },
  "deviceInfo": {
    object (DelegatedDeviceInfo)
  },
  "outputType": enum (OutputType)
}
Fields
userInfo

object (DelegatedUserInfo)

Optional. User details.

groupInfo

object (DelegatedGroupInfo)

Optional. Group details.

deviceInfo

object (DelegatedDeviceInfo)

Optional. The device information configuration.

outputType

enum (OutputType)

Optional. Default output type for all enabled headers.

DelegatedUserInfo

The configuration information for the delegated user.

JSON representation
{
  "outputType": enum (OutputType)
}
Fields
outputType

enum (OutputType)

Optional. The delegated user's information.

OutputType

The output type of the headers.

Enums
OUTPUT_TYPE_UNSPECIFIED The unspecified output type.
PROTOBUF Protobuf output type.
JSON JSON output type.
NONE Explicitly disable header output.

DelegatedGroupInfo

The delegated group configuration details.

JSON representation
{
  "outputType": enum (OutputType)
}
Fields
outputType

enum (OutputType)

Optional. The output type of the delegated group information.

DelegatedDeviceInfo

The delegated device information configuration.

JSON representation
{
  "outputType": enum (OutputType)
}
Fields
outputType

enum (OutputType)

Optional. The output type details for the delegated device.

GatewayIdentity

The security gateway identity type.

Enums
GATEWAY_IDENTITY_UNSPECIFIED Unspecified gateway identity.
RESOURCE_NAME Resource name for gateway identity, in the format: projects/{projectId}/locations/{locationId}/securityGateways/{securityGatewayId}