UserService (baja-UserService)

This service manages all system users: human and machine. You access it by right-clicking UserService and clicking Views > Property Sheet.

The User Manager is the primary view of this service. By default, creating a new station using the New Station wizard includes the UserService. The baja module makes this service available.

Figure 5. User Service property sheet view

To access these properties, expand Config > Services, right-click UserService and click Views > AX Property Sheet.

Property	Value	Description
Lock Out Enabled	`true` or `false`	Controls a user’s ability to log in. `true` temporarily disables login (user account) access based on a number of consecutive authentication failures for the duration of the `Lock Out Period`. Using lock out makes it difficult to automate the guessing of passwords. NOTE: Each user has a Clear Lock Out action.
Lock Out Period	`true` or `false`	Defines how long a user is unable to log in to a user account after consecutive authentication failures. While locked out, any login attempt (even a valid one) is unsuccessful. NOTE: The 10 second latency (default) guards against an automated, brute-force password attack, where a computer application issues hundreds of login attempts a second. You can adjust this value to guard against human attack.
Max Bad Logins Before Lock Out	Number from 1–10 (defaults to 5)	Specifies the number of consecutive failed user login attempts that trigger a lock out when `Lock Out Enabled` is `true` and `Lock Out Window` expires.
Lock Out Window	hours minutes seconds (defaults to 30 seconds)	Defines how long the user has to successfully log in when Lock Out Enabled is set to `true`. If a user fails to log in successfully before the `Max Bad Logins Before Lock Out` window (period) expires, the system locks the user out for the duration of the `Lock Out Period`. The system enforces changes to lock out properties the next time the user logs in. For example, if `Max Bad Logins Before Lock Out` is set to 5, user ScottF fails to log in four times within the `Lock Out Window`, and an admin-level user changes `Max Bad Logins Before Lock Out` to 3, the change does not lock ScottF out. User ScottF still has one more chance to log in before getting locked out. If ScottF’s fifth attempt to log in fails, the system locks him out the next time he attempts to log in because five failed attempts is greater than or equal to the `Max Bad Logins Before Lock Out` of 3.
Default Auto Logoff Period	0000h 15m (default)	Specifies the amount of time that a period of inactivity may last before a station connection is automatically disconnected. The acceptable range of values is two minutes to four hours. This limit is observed only when the User’s `Use Default Auto Logoff Period` property is set to `true`.
SMA Notification Settings	multiple properties	Configures the SMA (Software Maintenance Agreement) whose properties are documented in baja-SMANotificationSettings, which is in the Getting Started with Niagara.
User Prototypes	multiple properties	Serves as a container for the default and other user prototypes whose properties are documented in baja-UserPrototypes, which is in the Getting Started with Niagara.

UserService (baja-UserService)

Figure 5. User Service property sheet view

Related Links