Auth Options
Auth Options -- Options for controlling the behaviour of Auth
Auth Options
In addition to the options available for each container a series of options
can be included that control the behaviour of Auth itself.
Available Options
| Option |
Data Type |
Default value |
Description |
|
"sessionName"
|
string
|
"_authsession"
|
The name used to identify this Auth session. See
Auth::setSessionName()
|
|
"allowLogin"
|
boolean
|
TRUE
|
Whether to allow logins to be performed on this page. See
Auth::setAllowLogin()
|
|
"postUsername"
|
string
|
"username"
|
The name of the form field that contains the username to authenticate.
|
|
"postPassword"
|
string
|
"password"
|
The name of the form field that contains the password to authenticate.
|
|
"advancedsecurity"
|
boolean
|
FALSE
|
Whether to enable the advanced security features. See
Auth::setAdvancedSecurity()
|
|
"enableLogging"
|
boolean
|
FALSE
|
Whether to enable the internal logging system. See the
Logging Examples
and
Auth::attachLogObserver()
|
|
"regenerateSessionId"
|
boolean
|
FALSE
|
Set to TRUE to regenerate the session id on every page load or leave
as FALSE to regenerate only upon new login.
|