← Back to plugin index

Terms Of Service
Description

Configures the terms of services (legal disclaimer) that has to be accepted by the user during self-registration or when accessing an application.

When accessing a target application, the Loginapp checks whether the currently valid terms of services have been accepted by the user. The currently valid terms of services are referenced by the "TOS-tag" defined in this configuration. The accepted terms of services is stored in a user property (within context data container).

In order to perform the check, the login application must be configured such that it is involved every time an application is accessed for the first time within a session. Usually, this means that only the credentials/roles needed for the currently accessed application are granted to the Airlock Gateway (WAF) session.

Type name
TermsOfService
Class
com.airlock.iam.common.application.configuration.termsofservice.TermsOfServiceConfig
May be used by
Terms Of Services Step
License-Tags
TermsOfServices
Properties
Terms Of Service Tag (tag)
Description

An arbitrary string uniquely defining the currently valid legal disclaimer used for this application. The tag may be shared among several applications or with the self-registration process. Once the user accepts the disclaimer, this tag is saved with the user data (see next properties). If the user data has no or a different tag saved, the user is prompted to accept the current disclaimer.

The tag may not contain commas (",") or the timestamp separator (in case the timestamp pattern is specified).

Attributes
String
Mandatory
Example
AGB_2009
Example
TOS-1.2.1
Storage Strategy (storageStrategy)
Description
Defines how the terms of services tag is stored in the user's context data container:
  • Shared property (comma-separated) : The context data property (see below) is shared among several applications. The accepted tags are stored in a comma-separated value list.
  • Private property : The context data property (see below) is used only by this application.
  • Shared property (multi-value) : The context data property (see below) is shared among several applications. The accepted tags are stored in a multi-value attribute.
Attributes
String
Optional
Default value
Shared property (comma-separated)
Allowed values
Shared property (comma-separated), Private property, Shared property (multi-value)
Timestamp Format (timestampFormat)
Description
If set, a timestamp is stored with the tag in the user's context data container using the specified date format.
For example resulting in: TOS-2013:20130828134559+0100
Attributes
String
Optional
Suggested values
yyyyMMddHHmmssZ, yyyyMMdd
Timestamp Separator (timestampSeparator)
Description
If a timestamp is saved, this property specifies the separator used between the tag and the timestamp.
Notice that if storing them using Shared property (comma-separated), the comma cannot be used.
Attributes
String
Optional
Length <= 1
Default value
:
User Property Name (userPropertyName)
Description
The name of the property in the user's context data container holding the accepted tag(s).
Make sure that the used persister is configured to read/write the property!
Attributes
String
Mandatory
Suggested values
disclaimer_tag
Disclaimer Texts (disclaimerTexts)
Description

Defines a language-dependent, formatted disclaimer text displayed to the user.

If the user accessing an application and the terms of services have to be accepted, the whole terms / legal disclaimer can be displayed on the page.

If the user has to accept the terms of services during the self-registration, it makes sense to show only a link to the terms / legal disclaimer (it's only a checkbox label).

Attributes
Plugin-List
Mandatory
Assignable plugins
Disclaimer Text
YAML Template (with default values) 

type: TermsOfService
id: TermsOfService-xxxxxx
displayName: 
comment: 
properties:
  disclaimerTexts:
  storageStrategy: Shared property (comma-separated)
  tag:
  timestampFormat:
  timestampSeparator: :
  userPropertyName: