← Back to plugin index

Template-based Username Transformer
Description
Adds the ability to render any values provided by the configured value map provider into a template, that will define the transformed username.
Type name
TemplateBasedUsernameTransformer
Class
com.airlock.iam.flow.shared.application.configuration.user.TemplateBasedUsernameTransformerConfig
May be used by
Authentication Flow Kerberos SPNEGO Extractor Basic Auth Request Authentication SSI Passwordless Authentication Step SSI Authentication Step OTP Check via RADIUS Step Administrators Configuration Admin SSO Ticket Request Authentication One-Shot Authentication Flow Basic Auth HTTP Header Extractor Adminapp REST API Configuration SAML 2.0 Flow SP Authenticator-based One-Shot Target Application Certificate Authenticator Kerberos User Definition Session-less REST Endpoints Transaction Approval Flow RADIUS Authenticator SSO Ticket Request Authentication Radius Authentication Service Public Self-Service Flow Credential Data Certificate Matcher Client Certificate (X.509) Request Authentication
Properties
Template (template)
Description

Template from which the username is transformed. Placeholders (${value-selector}) are replaced by the corresponding value selected from the "Value Providers". Additionally the input username (current username in the transformation chain) is always provided as a value and can be referenced by ${input-username}.

Note: Placeholders that cannot be resolved, will be replaced with an empty value and the transformation chain will continue. Depending on the template and the usernames in the user data source, this might lead to an unintended identification of a user.

Attributes
String
Mandatory
Example
${input-username}.${organization}
Example
uid.${input-username}
Value Providers (valueProviders)
Description

These plugins provide the map of all values that are available as variables in the template.

Note: Providers providing values that are dependent on the user identity can't provide any values when the username transformation is evaluated. Thus only a few providers (e.g. additional attributes) can provide values at username transformation time.

Attributes
Plugin-List
Optional
Assignable plugins
Additional Password Check Attribute Map Airlock 2FA Authentication Data Map Airlock 2FA Login ID Parameter Authentication Data Map Conditional Value Map Provider Context Data Map Edited Context Data Map Generic Session Attribute Value Map Provider HTTP Request Information Map OAuth 2.0 Credential Context Data Map OAuth 2.0 Tokens Map Roles Provider SSI Verification Data Provider SSO Ticket Context Data Provider Script Execution Result Value Map Provider Transaction Approval Parameters Map Transforming Value Map Provider User Identity Map User Passwords Map User Statistics Map Value Provider Map mTAN Token Flow Value Map
Value Encoders (valueEncoders)
Description
Encode the values before they are inserted into the template. The encoders are applied in the configured order.
Attributes
Plugin-List
Optional
Assignable plugins
Base64 String Encoder HTML String Escaper JSON String Escaper URL String Encoder
YAML Template (with default values) 

type: TemplateBasedUsernameTransformer
id: TemplateBasedUsernameTransformer-xxxxxx
displayName: 
comment: 
properties:
  template:
  valueEncoders:
  valueProviders: