← Back to plugin index

Mapped Ticket Element

Description
This Ticket Element allows transforming the values in a ticket with a map that can be specified.
Type name
MappedTicketElement
Class
com.airlock.iam.core.misc.util.ticket.service.MappedTicketElement
May be used by
Properties
Value transformation map (transformationMap)
Description
Defines a key-value list with transformation rules for ticket element values.

For every ticket element value, a look-up into the map is performed. The value of the first matching entry replaces the original ticket element value. If no matching entry is found, the resulting ticket element value is determined by the configured 'No Match Behavior' which returns the original value by default.

Attributes
Plugin-List
Optional
Assignable plugins
No Match Behavior (noMatchBehavior)
Description
Defines which value is to be returned if no entry in the transformation map matches the input.
Attributes
Enum
Optional
Default value
ORIGINAL_VALUE
Ticket Key (ticketKey)
Description
This property defines the key used to put the value in the ticket.

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

Attributes
String
Mandatory
Example
username
Example
roles
Example
lang
Example
authentication-method
Value Reference (valueRef)
Description
This property specifies the context data key to use as value.
Some keys have special meanings to add the username, the roles or all additional values.
Attributes
String
Mandatory
Example
@username
Example
@roles
Example
@all-additional-values
Example
givenname
Example
surname
Example
country
Example
email
Example
company
Example
language
Example
authMethod
Mandatory (mandatory)
Description
Enforces that the value of the corresponding key is set and has only non-empty values. Depending on the valueRef this enforces after the transformation:
  • @username: only non empty usernames are allowed
  • @roles: at least one role must is assigned
  • context data key: the corresponding context data must exist and all values of the key must be non-empty
  • @all-context-data: the values of all context data must be non-empty
  • @all-additional-values: all additional data must have at least one value and all values must be non-empty
  • additional value key : the selected additional data must exist, have at least one value and all values must be non-empty
In case of violations, the ticket cannot be created and an exception, which will result in a technical error in most cases, is created.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)

type: MappedTicketElement
id: MappedTicketElement-xxxxxx
displayName: 
comment: 
properties:
  mandatory: false
  noMatchBehavior: ORIGINAL_VALUE
  ticketKey:
  transformationMap:
  valueRef: