UserDirectory

UserDirectory

UserDirectory

Defines an abstract user directory

Metadata

Instantiating 






authenticate()
Attempts to process a user. Runs every time the login form is loaded.


Arguments






Name
Type
Required
Default
Options
Description





None





getAllGroups()
Returns all the groups that this user directory supports


Arguments






Name
Type
Required
Default
Options
Description





None





getGroupUsers()
Returns all the users in a particular group


Arguments






Name
Type
Required
Default
Options
Description






group
string
Yes


The group to query






getLoginForm()
Returns the form component to use for login


Arguments






Name
Type
Required
Default
Options
Description





None





getProfile()
Returns profile data available through the user directory


Arguments






Name
Type
Required
Default
Options
Description






userid
string
Yes


The user directory specific user id




stCurrentProfile
struct
No


The current user profile






getUserGroups()
Returns the groups that the specified user is a member of


Arguments






Name
Type
Required
Default
Options
Description






UserID
string
Yes


The user being queried






init()
Does initialisation of user directory


Arguments






Name
Type
Required
Default
Options
Description





None





isEnabled()
Returns true if this user directory is active. This function can be overridden to check for the existence of config settings.


Arguments






Name
Type
Required
Default
Options
Description





None