← Back to plugin index

Ticket String Provider

Description
Provides an SSO ticket (e.g. a JWT ticket) as a string.
Type name
TicketStringProvider
Class
com.airlock.iam.flow.shared.application.configuration.TicketStringProviderConfig
May be used by
Properties
Value Providers (valueProviders)
Description
These plugins provide the map of all values that are available to create the ticket. Use the "Key-Value Pairs" property to define how the provided values are mapped into the ticket. The value providers are applied in the configured order. Later providers can overwrite values of earlier ones.
Attributes
Plugin-List
Optional
Assignable plugins
Key-Value Pairs (keyValues)
Description

List of key-value pairs that are included in the ticket. Each of them selects a value provided by the "Value Providers" and includes it in the ticket under a specified key.

Example: the Value Providers provide an entry with key "user-id" and value "tester". A key-value pair configuration with ticket key "username" and value selector "user-id" results in a ticket entry with key "username" and value "tester".

Attributes
Plugin-List
Optional
Assignable plugins
Validity [s] (validitySeconds)
Description
That validity duration of the ticket (in seconds).
Attributes
Long
Optional
Default value
600
URL Encoding Scheme (urlEncodingScheme)
Description
Encoding scheme for creating the ticket.
Attributes
String
Optional
Default value
UTF-8
Ticket Encoder (ticketEncoder)
Description

The ticket encoder plugin used to encode the ticket to a string.

Attention: Do not use the "Plain Ticket Encoder" when storing this value in a cookie, as it might contain illegal values for cookies.

Some ticket encoders do not support ticket expiry, i.e. they do not encode the ticket validity into the ticket.

Attributes
Plugin-Link
Mandatory
Assignable plugins
YAML Template (with default values)

type: TicketStringProvider
id: TicketStringProvider-xxxxxx
displayName: 
comment: 
properties:
  keyValues:
  ticketEncoder:
  urlEncodingScheme: UTF-8
  validitySeconds: 600
  valueProviders: