← Back to plugin index

URL Context Extractor
Description

Configures request URI to context mappings. If the request URI does not match, the fallback context is used.

The matching is performed against the part of the request URI after the protocol or after the host (depending on the configuration).

Example: If the request URL is "https://host/some/path" then the considered path is "host/some/path" (if "Use Virtual Host" is enabled) or "/some/path" otherwise.

To determine the request URI behind a gateway, Airlock IAM requires one of these gateway settings:
  • Airlock Gateway (WAF): Verify that "Environment Cookies" are activated on all Loginapp mappings and that the environment cookie prefix is the same in the Airlock Gateway and Airlock IAM. The URL parts are sent by the WAF in the HTTPS, SERVER_NAME, SERVER_REQUEST and SERVER_PORT cookies (with respect to the configured prefix)
  • Airlock Microgateway: Make sure to extract the request URI in Airlock Microgateway Settings.
Type name
URLContextExtractor
Class
com.airlock.iam.common.application.configuration.context.URLContextExtractor
May be used by
Combining Context Extractor Transaction Approval Concatenating Context Extractor Loginapp API Policy Service
Properties
Mappings (mappings)
Description
Defines a list of regular expressions matched against the request to determine the configuration contexts.
Attributes
Plugin-List
Mandatory
Assignable plugins
Context Pattern
Use Virtual Host (useVirtualHost)
Description
Also include the host name in the URL being matched.

If disabled, the Mappings only match against the path of the request URL, for example /auth/
If enabled, the Mappings match against the host name and path, for example www.server.com/auth/

Attributes
Boolean
Optional
Default value
false
Fallback Context (fallbackContext)
Description
Name of the context to be used if none of the mappings match.
Leave empty to implicitly use the default context. If this plugin is used within a "Combining Context Extractor", use "[DEFAULT]" to explicitly return the default context if necessary.
Attributes
String
Optional
Example
CTX1
Example
EXT
Example
[DEFAULT]
Gateway (gateway)
Description
Settings regarding an Airlock Gateway or Airlock Microgateway reverse proxy placed in front of Airlock IAM.

The request URI is extracted differently from the request based on this configuration:

  • Airlock Gateway (WAF): request URI is extracted from the environment cookie
  • Airlock Microgateway: request URI is extracted from the configured header
  • When no gateway is configured, the request URI is used

Attributes
Plugin-Link
Optional
Assignable plugins
Airlock Gateway Settings Airlock Microgateway Settings
YAML Template (with default values) 

type: URLContextExtractor
id: URLContextExtractor-xxxxxx
displayName: 
comment: 
properties:
  fallbackContext:
  gateway:
  mappings:
  useVirtualHost: false