← Back to plugin index

Encoded User Data Response Header
Description
HTTP header holding encoded information about values from the authentee to be set on the response of the identity propagation. A typical usecase for this header is JWT bearer token authorization.
Type name
EncodedUserDataResponseHeader
Class
com.airlock.iam.core.application.configuration.header.EncodedUserDataResponseHeader
May be used by
HTTP Response Header Identity Propagator
Properties
Name (name)
Description
The name of the header to be propagated to the HTTP client.
Attributes
String
Optional
Default value
Authorization
Example
Authorization
Example
X-Access-Token
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
Value Prefix (valuePrefix)
Description
If configured, the prefix is prepended to the encoded header value separated by a space.
Attributes
String
Optional
Suggested values
Bearer
YAML Template (with default values) 

type: EncodedUserDataResponseHeader
id: EncodedUserDataResponseHeader-xxxxxx
displayName: 
comment: 
properties:
  name: Authorization
  ticketEncoder:
  ticketService:
  urlEncodingScheme: UTF-8
  valuePrefix: