Regardless of type, all User Sources have the following functionality:
- Failover Source: If the User Source is unavailable for authentication, then a backup User Source can be specified. The type of the fail-over User Source can differ from the primary, so configurations where an internal-type fails over to a database-type are possible.
- Schedule Restrictions: The User Source can prevent users from logging in when they are off schedule, meaning that the schedule assigned to the user determines when the user may login.
All User Sources have a section of properties that are categorized as "Main". Below is a description of these properties.
|Name||The name of the User Source. This is how other systems in Ignition reference the user source. Note that every User Source must have a unique name.|
|Description||An optional description of the user source. Useful for noting which database connection or AD server the User Source may be referencing.|
|Schedule Restricted||Forces schedule restrictions on users. Specifically, if a user attempts to log into a client while they are off schedule, the login will fail. Utilizes User Schedules.|
Allows authentication attempts against this User Source to failover to another User Source in the event of a network outage, or some other connection issue. Useful with database or Active Directory user sources, as connection failures to the database/AD server will prevent users from logging in.
This property is initially set to None, meaning a failover User Source is not configured.
When a Failover Source is configured, this property determines when the failover User Source should be consulted. The following options are available:
Hard: The Failover User Source is only consulted when this User Source is unreachable.
Soft: The Failover User Source will be consulted if the user's credentials fail authentication, meaning that the user typed in credentials that are unrecognized or incorrect.
|Cache Validation Timeout|
The amount of time between cache updates of the User Source. If you set this value to -1, the cache validation timeout is turned off.
Lock out a user's account after more than the maximum allowed number of failed authentication attempts occur within the lockout window. Default is true.
Note that access can be restored to all locked out users by editing the user source, and clicking the Save Changes button.
Maximum number of failed authentication attempts allowed within the lockout window before locking the user out. Default is 5. If this value is set to something less than zero (for example, -1), then the lockout functionality will be entirely disabled, regardless of what the Lockout Enabled property is set to.
The duration of the lockout window in minutes. Default is 15. Setting this property to a value of less than zero (for example, -1) will disable the lockout functionality entirely, regardless of what the Lockout Enabled property is set to.
Details on the Password Policy Properties can be found on the Internal Authentication page.
The Default User Source
When Ignition is installed for the first time, an internal User Source named 'default' is created. You can manage the default User Source by navigating to the Config > Security > Users, Roles section of the Gateway.
The manage users link next to the 'default' user source allows you to add new users, modify roles and passwords for existing users, remove users, and add/remove roles from the user source.
When you open the 'default' user source for the first time, you will see the first user that was created at installation. This is the administrator account that has full privileges. If this user source has been modified before, a list of existing users is displayed.
Editing a User
Choosing to edit a user will bring you to the following page allowing you to make any necessary changes to that user. Fill out the fields for that user then click Save Changes.
|Username||The name of the User Source. This is how other systems in Ignition reference the user source. Note that every User Source must have a unique name.|
Check this box to change the existing password.
|Password||Re-type password for verification.|
|First Name||First name of the user.|
|Last Name||Last name of the user.|
|Roles||Role(s) assigned to this user. Check the box next to each role you want this user to have.|
|Schedule||Schedule for the user. Choose from a dropdown list of schedules that are already defined.|
|Language||Language to be used for the user. Choose from a dropdown list of languages that are already defined.|
|Any notes for this user.|
A string that represents the value set for the user's badge.
|Type||Choose email or SMS.|
|Value||The email value or SMS number.|