uid_configuration

Version: `v2024-10-30`	Includes use: No

Behavior name: UID Configuration

This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "uid_configuration" {
  rules_v2025_02_18 {
    name     = "UID Configuration"
    comments = "Extracts UID values from live traffic for use in OTA applications."
    behavior {
      uid_configuration {
        legal_text = ""
        enabled    = false
      }
    }
  }
}

"behaviors": [
  {
    "name": "uidConfiguration",
    "options": {
      "legalText": "",
      "enabled": false
    }
  }
]

Options

Option	Description
`enabled`	Boolean Allows you to extract UIDs from client requests.
`extract_location`	Enum Where to extract the UID value from. Value is one of: `CLIENT_REQUEST_HEADER`. From a client request header. `QUERY_STRING`. From the request query string. `VARIABLE`. From a rule tree `VARIABLE`You should mark these variables as sensitive. For more information, see Support for variables.
`header_name`	String \| Requires: `extract_location` is `CLIENT_REQUEST_HEADER` This specifies the name of the HTTP header from which to extract the UID value.
`query_parameter_name`	String \| Requires: `extract_location` is `QUERY_STRING` This specifies the name of the query parameter from which to extract the UID value.
`variable_name`	String \| Requires: `extract_location` is `VARIABLE` This specifies the name of the rule tree variable from which to extract the UID value.