FarcryUD

FarcryUD

FarcryUD

Provides the interface for the FarCry 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 specified 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





getOutputHashName()
Return the name of the hash used to encoded passwords


Arguments






Name
Type
Required
Default
Options
Description





None





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





migrate()
Migrates data from the previous DB structure and returns the results


Arguments






Name
Type
Required
Default
Options
Description





None





migrateBarnacles()
Migrates the role permissions


Arguments






Name
Type
Required
Default
Options
Description






permissions
struct
Yes


Maps old permission ids to new objectids




roles
struct
Yes


Maps old role ids to new objectids






migrateGroups()
Migrates the user directory groups and returns a struct mapping the old ids to the new objectids


Arguments






Name
Type
Required
Default
Options
Description





None





migrateMappings()
Migrates the mappings between the user directory groups and the Farcry roles


Arguments






Name
Type
Required
Default
Options
Description






groups
struct
Yes


Maps old group ids to new objectids




roles
struct
Yes


Maps old role ids to new objectids






migratePermissions()
Migrates the permission data, and returns a struct mapping the old ids to the new objectids


Arguments






Name
Type
Required
Default
Options
Description





None





migrateRoles()
Migrates the roles (policy groups previously) and returns a struct mapping the old ids to the new objectids


Arguments






Name
Type
Required
Default
Options
Description





None





migrateUserGroups()
Migrates the user directory groups


Arguments






Name
Type
Required
Default
Options
Description






users
struct
Yes


Maps old user ids to new objectids




groups
struct
Yes


Maps old gruop ids to new objectids






migrateUsers()
Migrates the user directory users and returns a struct mapping the old ids to the new objectids


Arguments






Name
Type
Required
Default
Options
Description





None





queryUserPassword()
Return a query of farUser rows that match the provided credentials


Arguments






Name
Type
Required
Default
Options
Description






username
string
Yes







password
string
Yes