← Back to plugin index

Remember-Me Settings
Description

Settings for the Remember-Me feature that allows to skip certain authentication steps if a valid token is present in the request.

When using this feature, the Remember-Me cookie must be configured as an encrypted pass-through cookie on the Airlock Gateway.

Type name
RememberMe
Class
com.airlock.iam.common.application.configuration.rememberme.RememberMeConfig
May be used by
Default Remember-Me Device Deletion Flow Remember-Me Token Clean-up Task Apply Remember-Me Device Deletion Remember-Me Device List Remember-Me Consistency User Change Listener Users Configuration Target Applications and Authentication Delete Remember-Me Device Initiation Step
Properties
Repository (repository)
Description
Configures the repository to store Remember-Me data.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Remember-Me Database Repository
Logout Behavior (logoutBehavior)
Description
This property controls what happens when a user explicitly logs out. It determines whether an explicit logout removes or keeps the Remember-Me cookie.
Attributes
Enum
Optional
Default value
REMOVE_COOKIE
Remove Remember-Me Tokens On Password Changes (removeRememberMeTokensOnPasswordChanges)
Description
If enabled, Remember-Me tokens will be removed on password changes.
Attributes
Boolean
Optional
Default value
true
Remove Remember-Me Tokens On User Locked (removeRememberMeTokensOnUserLocked)
Description
If enabled, Remember-Me tokens will be removed on locked users.
Attributes
Boolean
Optional
Default value
true
Lifetime (lifetime)
Description
The maximum duration the user will be remembered for. After this time, the token will be invalidated no matter whether it has been used recently or not.

Duration must be specified like "2d 4h 10m 5s" or any part thereof.

Attributes
String
Optional
Default value
7d
Example
10d
Example
8h
Example
2d 12h
Idle Timeout (idleTimeout)
Description
The optional idle timeout of the Remember-Me token. If a token hasn't been used for this amount of time, it will be invalidated no matter whether it has reached its lifetime or not. When this property is not set, a token will only expire when its lifetime has been reached or it has been invalidated by other means.

Duration must be specified like "2d 4h 10m 5s" or any part thereof.

Attributes
String
Optional
Example
10d
Example
8h
Example
2d 12h
Cookie Name (cookieName)
Description
The name of the Remember-Me cookie.

If this name is changed, the Airlock Gateway has to be reconfigured to pass-through and encrypt this cookie.

Attributes
String
Optional
Default value
RememberMe
Example
RememberMe
Cookie Domain (cookieDomain)
Description
The domain for which the cookie is set. If left empty, it will be automatically be sent back only to the originating domain which set the cookie in the first place.
Attributes
String
Optional
Validation RegEx: (?:^[^.].*$|^$)
Example
www.airlock.com
Example
airlock.com
Cookie Path (cookiePath)
Description
The path for which the cookie is set. The path determines where the cookie is sent to by the browser.

Use the variable "%ENTRYPATH%" to automatically set the correct path even if used behind an Airlock Gateway.

Attributes
String
Optional
Default value
%ENTRYPATH%
Example
%ENTRYPATH%
Example
/
Example
/auth
YAML Template (with default values) 

type: RememberMe
id: RememberMe-xxxxxx
displayName: 
comment: 
properties:
  cookieDomain:
  cookieName: RememberMe
  cookiePath: %ENTRYPATH%
  idleTimeout:
  lifetime: 7d
  logoutBehavior: REMOVE_COOKIE
  removeRememberMeTokensOnPasswordChanges: true
  removeRememberMeTokensOnUserLocked: true
  repository: