|
|
Whitebeam Library Definition
|
Tag Description
<rbm:extlogin>
Login using the cookie-based authentication module
See Also
extlogin() Syntax
<rbm:extlogin user=string password=string expiry=number community=string authok=string>body</rbm:extlogin>
Attributes
The 'rbm:extlogin' tag has 5 attributes:
| Name | Type/Value | Range/Length | Description | | user | string | 2 to 31 characters | Required.
Identify the username to log-in as. This is overidden if a form
value with a name of "sessionUser" is found.
| | password | string | 3 to 64 characters | Required.
Identify the password to log-in as. This is overidden if a form
value with a name of "sessionPass" is found.
| | expiry | number | | Optional.
Identify the default timeout for this login. This is overidden if a form
value with a name of "sessionExp" is found. Expiry of the Whitebeam
session will also cause a logout.
| | community | string | 2 to 31 characters | Required.
Identify the group of people against which the username and password
will be validated. This may select one or more Communities, individuals
or OUs (Organisational Units). To specify more than one, provide a comma
separated list with no white-space. This is overidden if a form
value with a name of "sessionComm" is found.
| | authok | string | 1+ characters | Optional.
The page to display if the user succesfully logs in. This takes the
form of a filename within the current website. If not specified, some
generic text is output in place of the login form. The special
value of "ignore" causes no action or redirection in the case of a
successful login.
|
Body
The rbm:extlogin body contains a form to prompt for login parameters.
Remarks Unless "user" and "password" values are provided, the rbm:extlogin tag
must encapsulate a form to collect the values for the login Form input fields required are: sessionUser, sessionPass, sessionExp
and sessionComm. | sessionUser : | Provides the username to log-in as. | | sessionPass : | Provides the password for the above user. | | sessionComm : | Optional. Allows the form to override the community set in the rbm:extlogin tag. | | sessionExp : | Optional. Sets the timeout for this login session. This is overridden by any Whitebeam session timeout. |
|
|
|
(loadtime : 8ms) |
