Database Token Persister
Description
Defines the table and column names, as well as additional query settings for the Database Token Persister.
This persister handles both token and token assignment data.
May be used by
Properties
SQL Data Source (
sqlDataSource) Description
Defines how connections to the database are obtained.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Token Table (
tokenTable) Description
The name of the database table containing the tokens.
Attributes
String
Mandatory
Suggested values
token
Token Sequence (
tokenSequence) Description
The name of the database sequence providing primary keys (Oracle only).
If left empty, Airlock IAM expects the database to support auto-increment columns (SQL Server, MySQL).
Attributes
String
Optional
Suggested values
token_seq
Token Col Token Id (
tokenColTokenId) Description
The name of the column holding the token identity (primary key).
This column needs to be set to auto_increment (H2, mysql,..) or the database sequence name must be configured (Oracle).
Attributes
String
Mandatory
Suggested values
token_id
Token Col Type (
tokenColType) Description
The name of the column holding the token type.
Attributes
String
Mandatory
Suggested values
type
Token Col Serial Id (
tokenColSerialId) Description
The name of the column holding the token serial.
Attributes
String
Mandatory
Suggested values
serial_id
Token Col Active (
tokenColActive) Description
The name of the column holding the active flag.
Attributes
String
Mandatory
Suggested values
active
Token Col Activation Date (
tokenColActivationDate) Description
The name of the column holding the activation date.
Attributes
String
Mandatory
Suggested values
activation_date
Token Col Obsoletes Token Id (
tokenColObsoletesTokenId) Description
The name of the column holding the 'obsoletes_token' token reference (foreign key).
Stores a reference to the token that gets deactivated the next time this token is used.
Attributes
String
Mandatory
Suggested values
obsoletes_token_id
Token Col Validity Range Lower (
tokenColValidityRangeLower) Description
The name of the column holding the validity range lower bound.
Attributes
String
Mandatory
Suggested values
validity_range_lower
Token Col Validity Range Upper (
tokenColValidityRangeUpper) Description
The name of the column holding the validity range upper bound.
Attributes
String
Mandatory
Suggested values
validity_range_upper
Token Col Generation Date (
tokenColGenerationDate) Description
The name of the column holding the generation date.
Attributes
String
Mandatory
Suggested values
generation_date
Token Col First Usage Date (
tokenColFirstUsageDate) Description
The name of the column holding the first usage date.
Attributes
String
Mandatory
Suggested values
first_usage_date
Token Col Latest Usage Date (
tokenColLatestUsageDate) Description
The name of the column holding the latest usage date.
Attributes
String
Mandatory
Suggested values
latest_usage_date
Token Col Total Usages (
tokenColTotalUsages) Description
The name of the column holding the number of total usages.
Attributes
String
Mandatory
Suggested values
total_usages
Token Col Token Data (
tokenColTokenData) Description
The name of the column holding the token data.
Attributes
String
Mandatory
Suggested values
token_data
Token Col Activates Token Id (
tokenColActivatesTokenId) Description
The name of the column holding the 'activates_token' token reference (foreign key).
Stores a reference to the token that gets activated the next time this token is used.
Attributes
String
Mandatory
Suggested values
activates_token_id
Token Col Generic Data Element1 (
tokenColGenericDataElement1) Description
The name of the 1st column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_1
Token Col Generic Data Element2 (
tokenColGenericDataElement2) Description
The name of the 2nd column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_2
Token Col Generic Data Element3 (
tokenColGenericDataElement3) Description
The name of the 3rd column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_3
Token Col Generic Data Element4 (
tokenColGenericDataElement4) Description
The name of the 4th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_4
Token Col Generic Data Element5 (
tokenColGenericDataElement5) Description
The name of the 5th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_5
Token Col Generic Data Element6 (
tokenColGenericDataElement6) Description
The name of the 6th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_6
Token Col Generic Data Element7 (
tokenColGenericDataElement7) Description
The name of the 7th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_7
Token Col Generic Data Element8 (
tokenColGenericDataElement8) Description
The name of the 8th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_8
Token Col Generic Data Element9 (
tokenColGenericDataElement9) Description
The name of the 9th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_9
Token Col Generic Data Element10 (
tokenColGenericDataElement10) Description
The name of the 10th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_10
Token Col Generic Data Element11 (
tokenColGenericDataElement11) Description
The name of the 11th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_11
Token Col Generic Data Element12 (
tokenColGenericDataElement12) Description
The name of the 12th column holding generic token data.
Attributes
String
Mandatory
Suggested values
generic_data_element_12
Token Col Tracking Id (
tokenColTrackingId) Description
The name of the column holding the tracking identity.
Attributes
String
Optional
Suggested values
tracking_id
Token Additional Where Clause (
tokenAdditionalWhereClause) Description
Optional SQL query condition that is added to the WHERE clause when searching for, updating or deleting tokens.
- Example for an SQL query without an additional WHERE clause:
SELECT * FROM token WHERE type = 'myTokenType' - Example for an SQL query with an additional WHERE clause "
foo()":SELECT * FROM token WHERE type = 'myTokenType' AND foo()
Note that this WHERE clause may be overridden for the token lookup using the property: "Token Search Additional Where Clause"
Attributes
String
Optional
Example
generic_data_element_1 = 'myData1'
Token Search Additional Where Clause (
tokenSearchAdditionalWhereClause) Description
Same as the property "Token Additional Where Clause", but the additional WHERE clause of this property is only used to search tokens.
Attributes
String
Optional
Example
generic_data_element_1 = 'myData1'
Additional Token Insert Data (
additionalTokenInsertData) Description
This property defines a list of name/value pairs used in insert statements when a new token record is inserted.
This allows you to add arbitrary fixed or dynamic values when a new record is created.
Caution: Make sure to appropriately escape values (e.g. use single quotes around strings). They are used as provided in the SQL insert statements. This allows calling database dependent functions (e.g. in order to get a sequence number, system date, etc). Also, do not use any of the standard fields of the token table.
Attributes
Plugin-List
Optional
Assignable plugins
Token Assignment Table (
tokenAssignmentTable) Description
The name of the database table containing the token assignments.
Attributes
String
Mandatory
Suggested values
token_assignment
Token Assignment Col Token Id (
tokenAssignmentColTokenId) Description
The name of the column holding the identity referencing the assigned token (foreign key).
Attributes
String
Mandatory
Suggested values
ta_token_id
Token Assignment Col User (
tokenAssignmentColUser) Description
The name of the column holding the name of the user whom the token is assigned to.
Attributes
String
Mandatory
Suggested values
ta_user
Token Assignment Col Assignment Date (
tokenAssignmentColAssignmentDate) Description
The name of the column holding the date of the assignment.
Attributes
String
Mandatory
Suggested values
ta_assignment_date
Token Assignment Col Assignment User (
tokenAssignmentColAssignmentUser) Description
The name of the column holding the name of the user that did the assignment.
Attributes
String
Mandatory
Suggested values
ta_assignment_user
Token Assignment Col Order New (
tokenAssignmentColOrderNew) Description
The name of the column holding the flag indicating whether a new token has been ordered.
Attributes
String
Mandatory
Suggested values
ta_order_new
Token Assignment Col Order New User (
tokenAssignmentColOrderNewUser) Description
The name of the column holding the name of the user that placed the order for a new token.
Attributes
String
Mandatory
Suggested values
ta_order_new_user
Token Assignment Col Order New Date (
tokenAssignmentColOrderNewDate) Description
The name of the column holding the date where a new token was ordered.
Attributes
String
Mandatory
Suggested values
ta_order_new_date
Token Assignment Col Order Options (
tokenAssignmentColOrderOptions) Description
The name of the column holding the options of a token order.
Attributes
String
Optional
Suggested values
ta_order_options
Token Assignment Col Additional Information (
tokenAssignmentColAdditionalInformation) Description
The name of the column holding additional token assignment information.
Attributes
String
Optional
Suggested values
ta_additional_information
Token Assignment Col Comment (
tokenAssignmentColComment) Description
The name of the column holding the token assignment comments.
Attributes
String
Optional
Suggested values
ta_comment
Token Assignment Additional Where Clause (
tokenAssignmentAdditionalWhereClause) Description
Optional SQL query condition that is added to the WHERE clause when searching for, updating or deleting token assignments.
- Example for an SQL query without additional WHERE clause:
SELECT * FROM token_assignment WHERE ta_user = 'user' - Example for an SQL query with additional WHERE clause "
foo()":SELECT * FROM token_assignment WHERE ta_user = 'user' AND foo()
Attributes
String
Optional
Example
ta_comment = 'myComment1'
Additional Token Assignment Insert Data (
additionalTokenAssignmentInsertData) Description
This property defines a list of name/value pairs used in insert statements when a new token assignment record is inserted.
This allows you to add arbitrary fixed or dynamic values when a new record is created.
Caution: Make sure to appropriately escape values (e.g. use single quotes around strings). They are used as provided in the SQL insert statements. This allows calling database dependent functions (e.g. in order to get a sequence number, system date, etc). Also, do not use any of the standard fields of the token assignment table.
Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)
type: DatabaseTokenPersister
id: DatabaseTokenPersister-xxxxxx
displayName:
comment:
properties:
additionalTokenAssignmentInsertData:
additionalTokenInsertData:
sqlDataSource:
tokenAdditionalWhereClause:
tokenAssignmentAdditionalWhereClause:
tokenAssignmentColAdditionalInformation:
tokenAssignmentColAssignmentDate:
tokenAssignmentColAssignmentUser:
tokenAssignmentColComment:
tokenAssignmentColOrderNew:
tokenAssignmentColOrderNewDate:
tokenAssignmentColOrderNewUser:
tokenAssignmentColOrderOptions:
tokenAssignmentColTokenId:
tokenAssignmentColUser:
tokenAssignmentTable:
tokenColActivatesTokenId:
tokenColActivationDate:
tokenColActive:
tokenColFirstUsageDate:
tokenColGenerationDate:
tokenColGenericDataElement1:
tokenColGenericDataElement10:
tokenColGenericDataElement11:
tokenColGenericDataElement12:
tokenColGenericDataElement2:
tokenColGenericDataElement3:
tokenColGenericDataElement4:
tokenColGenericDataElement5:
tokenColGenericDataElement6:
tokenColGenericDataElement7:
tokenColGenericDataElement8:
tokenColGenericDataElement9:
tokenColLatestUsageDate:
tokenColObsoletesTokenId:
tokenColSerialId:
tokenColTokenData:
tokenColTokenId:
tokenColTotalUsages:
tokenColTrackingId:
tokenColType:
tokenColValidityRangeLower:
tokenColValidityRangeUpper:
tokenSearchAdditionalWhereClause:
tokenSequence:
tokenTable: