← Back to plugin index

Encoded User Data Header
Description
Configuration for encoded userdata header propagation. Examples are JWT Bearer token Authorization header.
Type name
EncodedUserDataHeader
Class
com.airlock.iam.core.misc.impl.sso.EncodedUserDataHeader
May be used by
HTTP Header Identity Propagator
Properties
Name (name)
Description
The name of the encoded user data header to be propagated to the back-end application.
Attributes
String
Optional
Default value
Authorization
Example
mandate
Example
stage
Ticket Service (ticketService)
Description
The ticket service providing the authentication ticket with the configuration of the ticket elements.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Mapping Ticket Service
Ticket Encoder (ticketEncoder)
Description
The ticket encoder plugin used to encode the authentication ticket in a string.

Note that some ticket encoders do not support ticket expiration, i.e. they do not encode the ticket validity into the ticket.

Attributes
Plugin-Link
Mandatory
Assignable plugins
AES256 Encryption Ticket Encoder Esp Sign Ticket Encoder Gzip Base64 Ticket Encoder JWT Ticket Encoder Plain Base64 Ticket Encoder Plain Ticket Encoder RSA Sign Ticket Encoder
URL Encoding Scheme (urlEncodingScheme)
Description
String values should be URL encoded in order to be suitable as header values. This optional property defines the URL encoding scheme to be used.
Make sure that the component receiving the ticket uses the same URL encoding scheme.
Attributes
String
Optional
Default value
UTF-8
Allowed values
UTF-8, ISO-8859-1, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, ISO-8859-15
Add Prefix To Value (addPrefixToValue)
Description
Whether to prepend the configured prefix to the header value. The prefix is separated from the value with a space.
Attributes
Boolean
Optional
Default value
true
Value Prefix (valuePrefix)
Description
A prefix to prepend to the encoded header value. The prefix is separated from the value with a space.
Attributes
String
Optional
Default value
Bearer
Suggested values
Bearer
Mapping Names (mappingNames)
Description
For each header, this property optionally defines the name of the Airlock Gateway (WAF) mappings to use it on.
If no mapping name is specified, the HTTP header is used on all Airlock Gateway mappings.

Note: Headers must never be defined globally and on a specific mapping at the same time.

Attributes
String-List
Optional
YAML Template (with default values) 

type: EncodedUserDataHeader
id: EncodedUserDataHeader-xxxxxx
displayName: 
comment: 
properties:
  addPrefixToValue: true
  mappingNames:
  name: Authorization
  ticketEncoder:
  ticketService:
  urlEncodingScheme: UTF-8
  valuePrefix: Bearer