← Back to plugin index

Query Parameter URI Value Extraction

Description
Extracts a URI from the query parameter of the input URI. The query parameters are URL-decoded during parsing of the input URI and normally do not have to be decoded again. If the input URI contains multiple query parameters with the configured name, the first value that matches an allow pattern is returned. If the input URI does not contain the configured parameter or none of the values match the allow patterns, no URI is returned.
Type name
QueryParameterURIValueExtractor
Class
com.airlock.iam.login.application.configuration.location.extract.QueryParameterURIValueExtractorConfig
May be used by
Properties
Parameter Name (parameterName)
Description
The name of the query parameter that contains the URI to extract.
Attributes
String
Mandatory
Example
Location
Example
forward_url
Allowed URI Patterns (allowedUriPatterns)
Description

A list of regular expressions defining the allowed URI patterns.

A URI is accepted if at least one of the configured regular expressions matches. At least one pattern must be configured.

A regex that is too general can lead to open redirects.

Attributes
RegEx-List
Mandatory
YAML Template (with default values)

type: QueryParameterURIValueExtractor
id: QueryParameterURIValueExtractor-xxxxxx
displayName: 
comment: 
properties:
  allowedUriPatterns:
  parameterName: