Skip to the content
Documentation

[UserSettings]

No ratings yet
Setting Summary
AnonymousUserID Sets the Exponential user that should be used for anonymous page requests.
AuthenticateMatch Sets the fields that are accepted for login authentication.
DefaultSectionID Sets the section ID of self registered users.
DefaultUserNameValidationErrorText Settings regarding custom validation of user names
DefaultUserPlacement Sets the parent object of all users who register themselves
EmailRegistrationInfo Set whether a confirmation email is sent to the user after he validated his account or not. (>= Exponential 5.3)
ExtensionDirectory Sets the extensions that contain login handlers
GeneratePasswordIfEmpty Sets if Exponential should generate passwords if the password field is empty.
GeneratePasswordLength Sets the length of passwords generated by Exponential.
HashType Sets the type of encryption that will be used when storing user passwords in the database.
LoginHandler Sets the various methods Exponential will try to authenticate user logins.
LoginRedirectionUriAttribute Sets which attribute of the user/usergroup class contains redirection URI for the user.
LogoutRedirect Sets which page to redirect to when a user has logged out.
MaxNumberOfFailedLogin Sets the number of failed login attempts before user accounts are locked.
RedirectOnLogoutWithLastAccessURI Sets if LastAccessURI session variable is used to redirect the user at logout.
RegistrationEmail Sets the receiver of notification emails about new users.
RegistrationFeedback Sets the kind of feedback that is sent to users that have registered.
RequireConfirmEmail Controls whether users are required to confirm their emails
RequireUniqueEmail Sets if all users must have unique email addresses when registering.
ShowMessageIfExceeded Sets whether to display a warning when a user is not allowed to log in.
SiteName Sets the site name to use when encrypting user passwords.
TrustedIPList Sets IP addresses that users can log in from even though their accounts are locked.
UpdateHash Sets if Exponential should update hashes if you have changed the HashType setting
UserClassGroupID Sets which classes you can create in the user section in the administration interface.
UserClassID Sets the class to use for user registration
UserCreatorID Sets the user that will bet set as the creator of self registering users.
UserGroupClassID Sets the class ID of the class that represents user groups.
UserNameValidationErrorText Settings regarding custom validation of user names
UserNameValidationRegex Settings regarding custom validation of user names
UseSpecialCharacters Sets if special characters are allowed in passwords.
VerifyUserEmail Sets if new users have to verify their account by email.

Changed in Exponential 6.0.15

Settings of this group in the settings files of Exponential 6.0.15 that this page does not describe:

Setting File Default Description
MinPasswordLength settings/site.ini 10 Minimum password length
WeakPasswordCheck settings/site.ini enabled Refuse a well-known or common password (expWeakPasswordList: "admin", "password", "qwerty", "123456", the software's own names and the like, with their simple variants: case, digits and symbols at the ends, letter swaps such as "p@ssw0rd", common endings, a word typed twice; also keyboard runs and repeated characters). Checked for every new password: user/password, registration, the user edit form, exp:resetuserpassword and the web services. Signing in with an existing password is never refused. The installers (setup wizard, kickstarter, exp:install) always check, whatever this says. disabled: only the length and [PasswordSettings] count.
WeakPasswordFile settings/site.ini (empty) More words to refuse, one per line, in their base form (variants are refused too) WeakPasswordList[] WeakPasswordList[]=ourcompanyname A file with more words, one per line (# starts a comment), relative to the installation root or absolute; read once per process while it is unchanged WeakPasswordFile=settings/weak-passwords.txt
ForgotPasswordKeyLifetime settings/site.ini 3600 Seconds a "Forgot your password?" link works after it was sent (3600: one hour). An expired link is refused with its own message; expired links are removed on the next visit of user/forgotpassword. 0: a link works until it is used (the behavior before 6.0.15).
VerifyUserType settings/site.ini email Type of verification for user registration, email is only type supported nativly, set to blank to disable. Example on how to set up custom verification: 'verifyUser' function will be used on the class, look in kernel/user/register.php for how the email code is implemented! return value of function decides if user mail should be sent or not. [VerifyUserType_<custom_type>] Class=<custom_type_class_name> #File is optional, autoload will be used if not set File=<custom_type_file_path>
PasswordInRegistrationEmail settings/site.ini disabled If set to enabled, user password would be send in the registration email This password WON'T be stored in plain text
ActivationByAdministratorSendsApprovalMail settings/site.ini enabled Whether Activate on Users > Unactivated users (user/unactivated) sends the activated user the "registration approved" mail (user/registrationapproved.tpl), as the user's own activation link does. disabled activates silently. EmailRegistrationInfo=disabled switches that mail off everywhere.
RegistrationAdminLinks settings/site.ini enabled The administrator's "New user registered" mail (RegistrationFeedback=email, user/registrationfeedback.tpl) carries signed links to the administration: view the account, approve (activate) it, reject (remove) it, and the approval item when a workflow holds it. Each opens user/registration, which asks the signed-in administrator to confirm. Guide: doc/eng-us/features/6.0/registration-admin-links.md enabled or disabled (the mail then has no links)
RegistrationAdminBaseURL settings/site.ini (empty) The address of the administration the links point to, e.g. https://admin.example.com or https://www.example.com/admin. Empty: https:// and the SiteURL of RegistrationAdminSiteAccess, else that siteaccess's address.
RegistrationAdminSiteAccess settings/site.ini (empty) The administration siteaccess. Empty: the siteaccess whose [SiteSettings] FrontSiteAccess is this one, else admin.
RegistrationActionTTL settings/site.ini 604800 How long a link works, in seconds (604800 = 7 days). Approve and reject links work once.
AccountApprovalMode settings/site.ini group How the setup (setup wizard, kickstarter) sets up the approval of new editor accounts: group (the default: the workflow event "Approve user accounts", decided by the group an account is placed in), section (the section Staff for Administrator users and Editors and the plain approval event on it) or none. Choose one, never both: an account would be asked for twice. An installation that exists: bin/php/adduserapproval.php --apply [--mode=section]. Guide: doc/eng-us/bc/6.0/user-account-approval.md
RegisterAutoLogin settings/site.ini enabled If set to disabled, the user will not be automatically logged in while registering even if the user is automatically activated
DeactivateAndMove settings/site.ini disabled "Deactivate and move" (doc/eng-us/features/6.0/user-hygiene.md): enabled offers, on a user's page, in the context menu and on Users > Check user accounts, to disable accounts and bring all their locations together in one hidden user group without roles, remembering where they were, and to move them back on reactivation; a way to retire accounts without removing them (users never go to the trash). disabled (the default) shows nothing and creates nothing. Needs the policy user/deactivate.
DeactivatedUserGroupNodeID settings/site.ini (empty) The node of that group. Empty: the user group with the remote id exp_deactivated_users_group, created below content.ini [NodeSettings] UserRootNode on first use (or beforehand by bin/php/ezcreatedeactivatedusergroup.php). A node id set here that does not exist stops the action; it is never replaced by a new group.
SingleSignOnHandlerArray settings/site.ini (empty) Defines the available single sign on handlers.

In this section

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.