← Back to plugin index

One-Shot Response Mapper

Description
Defines status code and headers of one-shot responses. This mapper is applied if both the "Error Code Matcher" and the "Next Step Matcher" match the flow result.
Type name
OneShotResponseMapper
Class
com.airlock.iam.authentication.application.configuration.targetapp.OneShotResponseMapperConfig
May be used by
License-Tags
OneShotAuthentication
Properties
Error Code Matcher (errorCodeMatcher)
Description
Pattern to match the error code of the response. The absence of an error code is represented as the empty string and can be matched using the pattern "^$". Conversly, a non-empty error code can be matched using the pattern ".+".
Attributes
RegEx
Optional
Default value
.*
Next Step Matcher (nextStepMatcher)
Description
Pattern to match the next step of the response. The absence of a next step is represented as the empty string and can be matched using the pattern "^$". Conversly, a non-empty error code can be matched using the pattern ".+".
Attributes
RegEx
Optional
Default value
.*
HTTP Status Code (httpStatusCode)
Description
The HTTP status code to set on the response.
Attributes
Integer
Optional
Default value
401
Headers (headers)
Description
Headers to be added to the response. Only headers with non-blank value are added.
Attributes
Plugin-List
Optional
Assignable plugins
Workflow (workflow)
Description
Controls the Airlock Gateway (WAF) workflow:
  • CONTINUE: the Gateway interprets the one-shot response (e.g. adds roles/credentials etc) and then re-evaluates access to the requested URL and either lets the request pass or answers with the standard 403 response.
  • FINAL_RESPONSE: (default) the response of the one-shot request is directly passed to the client, including added headers (e.g. WWW-Authenticate header).
Attributes
Enum
Optional
Default value
FINAL_RESPONSE
YAML Template (with default values)

type: OneShotResponseMapper
id: OneShotResponseMapper-xxxxxx
displayName: 
comment: 
properties:
  errorCodeMatcher: .*
  headers:
  httpStatusCode: 401
  nextStepMatcher: .*
  workflow: FINAL_RESPONSE