Java Agents 2024.9

Regex Remove Query Parameters List for Policy Evaluation

A list of regular expressions the agent uses to match query parameters to be removed from the incoming URL for policy evaluation and caching purposes. The property has the following format, with no spaces between values:

[Domain[/path]]|parameter[,parameter…​]

Consider the following constraints when constructing your list of regular expressions:

  • Add a comma (,) character at the beginning or the end of the list to remove all unnamed parameters. For example, myapp.example.com/customers|,lang would match both lang and any unnamed parameters.

  • Consider creating multiple simple regular expressions instead of a single complicated one.

  • The remaining parameters (those that do not match the list of parameters) are sorted alphabetically.

Examples:

org.forgerock.agents.unwanted.http.url.params.regex.list[0]=myapp.example.com|b.*,gp(a|p|s),

org.forgerock.agents.unwanted.http.url.params.regex.list[1]=|.*

The following incoming URL request that matches a rule such as myapp.example.com/customers|,coun.*?:

http://myapp.example.com/customers?country=uk&=bristol&lang=en_GB&area=1343456

It is cached by the agent as http://myapp.example.com/customers?=bristol&lang=en_GB, where both country and unnamed parameter are removed and the remaining parameters are sorted alphabetically.

Property name

org.forgerock.agents.unwanted.http.url.params.regex.list

Aliases

org.forgerock.agents.unwanted.http.url.params.regex.list
  Introduced in Java Agent 5.6

org.forgerock.openam.agents.config.conditional.unwanted.http.url.params.regexp
  Introduced in Java Agent 5.6
  Recognized from AM 7

org.forgerock.agents.unwanted.http.url.params.regexp.list
  Introduced in Java Agent 5.6

Function

Query parameter

Type

List

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Miscellaneous (from AM 7)

Title: Regex Remove Query Parameters List for Policy Evaluation

Legacy title: Regular Expression Remove Query Parameters

Copyright © 2010-2024 ForgeRock, all rights reserved.