← Back to plugin index

Locking Settings (Adminapp)

Description

This plugin defines the lock reasons admins can select when locking users, the behavior when users are locked temporarily, and the handling of active user sessions at the time of locking.

Users may be locked automatically (e.g. after a certain amount of failed logins) or manually by the administrator.

Type name
LockingSettings
Class
com.airlock.iam.admin.application.configuration.users.LockingSettings
May be used by
Properties
Lock Reasons (lockReasons)
Description

Identity strings that define the lock reasons administrators can select when manually locking a user. Typically, these strings are set to the locale identifiers used with translation.

The following manual lock reasons are predefined:

LockReason.InitiatedByUser = "Requested by user" LockReason.InitiatedByAdmin = "Locked by administrator"

Attributes
String-List
Optional
Default value
[LockReason.InitiatedByUser, LockReason.InitiatedByAdmin]
Temporary Locking (temporaryLockingConfig)
Description
Settings for displaying temporary locking information on the user detail page. These should be the same settings as those used in the Loginapp to ensure consistent locking durations.
Attributes
Plugin-Link
Optional
Assignable plugins
Session Lock Behavior (sessionLockBehavior)
Description

Defines how to handle existing user sessions at the time of locking.

Note: Only applicable if the Adminapp is deployed behind the same Airlock Gateway (WAF) as the Loginapp.

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

type: LockingSettings
id: LockingSettings-xxxxxx
displayName: 
comment: 
properties:
  lockReasons: [LockReason.InitiatedByUser, LockReason.InitiatedByAdmin]
  sessionLockBehavior:
  temporaryLockingConfig: