← Back to plugin index

Plain User Data Header
Description
Holds information about values from the authentee to put in an HTTP header using the back-end Airlock control API.
Type name
PlainUserDataHeader
Class
com.airlock.iam.core.misc.impl.sso.PlainUserDataHeader
May be used by
HTTP Header Identity Propagator
Properties
Name (name)
Description
This property defines the header name used for this entry.

Note that for the special value @all-context-data, the value of this property is ignored because the header name of the context data entries is used.

Attributes
String
Mandatory
Example
username
Example
roles
Example
lang
Example
authentication-method
Value (value)
Description
This property defines the values to be propagated as HTTP headers. The values are taken from the authentee including its context data container.

The values are interpreted as follows:

  • The value @username refers to the authentee's name.
  • The value @roles refers to the authentee's roles.
  • The value @info:key refers to the element of the additional input data with the given key.
  • The value @all-context-data refers to all context data of the authentee. If used, each context data entry is added as a separate header using its key as header name. The 'Name' propery is ignored.
    Be careful with this setting as context-data entries may overwrite important HTTP headers in back-end requests. It is recommended to add multiple explicit headers instead to keep control over the headers set.
  • All other values are used to reference a value in the context data container of the authentee.

Attributes
String
Mandatory
Suggested values
@username, @roles, @all-context-data, @info:OAUTH2_ACCESS_TOKEN, givenname, surname, country, email, company, language, auth_method
Value Prefix (valuePrefix)
Description
If set, this prefix (plus a space) is prepended to the header value.
Attributes
String
Optional
Example
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: PlainUserDataHeader
id: PlainUserDataHeader-xxxxxx
displayName: 
comment: 
properties:
  mappingNames:
  name:
  value:
  valuePrefix: