User Locked Predicate
Description
Returns true for users who are locked.
If configured, the lock date must lie outside the grace period and the lock reason must match the pattern.
May be used by
Properties
Locked Grace Period (
lockedGracePeriod) Description
The grace period during which the predicate remains false after a user is locked. If not configured, the grace period is ignored. If configured but no lock date is set on the user (i.e. the corresponding database field is null), the predicate returns false.
Attributes
String
Optional
Example
90d
Example
1d 12h
Lock Reason Pattern (
lockReasonPattern) Description
The lock reason must match this regular expression. If not configured, the lock reason is not checked. If configured but no lock reason is set on the user (i.e. the corresponding database field is null), the predicate returns false. The following are the most frequent lock reasons:
- LockReason.TooManyLoginFailed
- LockReason.InitialPasswordExpired
- LockReason.MaxWrongOldPassword
- LockReason.InitiatedByUser
- LockReason.InitiatedByAdmin
Note: Additional custom lock reasons may be present, depending on the IAM configuration.
Attributes
RegEx
Optional
YAML Template (with default values)
type: UserLockedPredicate
id: UserLockedPredicate-xxxxxx
displayName:
comment:
properties:
lockReasonPattern:
lockedGracePeriod: