← Back to plugin index

Plain User Data Response Header
Description
HTTP header holding information about values from the authentee to be set on the response of the identity propagation.
Type name
PlainUserDataResponseHeader
Class
com.airlock.iam.core.application.configuration.header.PlainUserDataResponseHeader
May be used by
HTTP Response Header Identity Propagator
Properties
Name (name)
Description
The name of the response header to be propagated to the HTTP client.
Attributes
String
Mandatory
Example
Authorization
Example
X-Access-Token
Value (value)
Description
The value of the response header to be propagated to the HTTP client.

The value is based on the authentee including its context data container:

  • The value @username refers to the authentee's name.
  • The value @roles refers to the authentee's roles. The roles are set as comma-separated string (e.g. role1,role2). If the authentee has no roles, the header is not set.
  • All other values are used to reference a value in the context data container of the authentee. If the value is not present on the context data container, the header is not set.

Attributes
String
Mandatory
Suggested values
@username, @roles, givenname, surname, country, email, company, language, auth_method
Encoder (encoder)
Description
Encodes the header value.
Attributes
Plugin-Link
Optional
Assignable plugins
URL Encoder
YAML Template (with default values) 

type: PlainUserDataResponseHeader
id: PlainUserDataResponseHeader-xxxxxx
displayName: 
comment: 
properties:
  encoder:
  name:
  value: