fwAccessControl  8.4.0
User-manipulation functions

User-related functions

see also the module User manipulation functions

void fwAccessControl_getAllUsers (dyn_string &userlist, dyn_string &fullUserNames, dyn_string &exceptionInfo)
 
void fwAccessControl_getUser (string userName, string &userFullName, string &description, int &userId, bool &enabled, dyn_string &groupNames, dyn_string &exceptionInfo)
 
void fwAccessControl_deleteUser (string userName, dyn_string &exceptionInfo) synchronized(_fwAccessControl_mutex)
 
void fwAccessControl_createUser (string userName, string userFullName, string userComment, bool enabled, string password, dyn_string groupMembership, dyn_string &exceptionInfo, int userId=-1, bool passwordAlreadyCrypted=FALSE, bool localAccount=FALSE) synchronized(_fwAccessControl_mutex)
 
bool fwAccessControl_isUserAccountLocal (string userName, dyn_string &exceptionInfo)
 
void fwAccessControl_getUserRoles (string userName, dyn_string &userRoles, dyn_int &roleLevels, dyn_string &exceptionInfo)
 
void fwAccessControl_updateUser (string userName, string newUserName, string userFullName, string userComment, bool enabled, string password, dyn_string groupMembership, dyn_string &exceptionInfo, bool passwordAlreadyCrypted=FALSE, bool localAccount=FALSE) synchronized(_fwAccessControl_mutex)
 
void fwAccessControl_enableUserAccount (string userName, bool enabled, dyn_string &exceptionInfo) synchronized(_fwAccessControl_mutex)
 

Detailed Description

Function Documentation

void fwAccessControl_getAllUsers ( dyn_string &  userlist,
dyn_string &  fullUserNames,
dyn_string &  exceptionInfo 
)

get the list of all users

void fwAccessControl_getUser ( string  userName,
string &  userFullName,
string &  description,
int &  userId,
bool &  enabled,
dyn_string &  groupNames,
dyn_string &  exceptionInfo 
)

get details concerning a user

void fwAccessControl_deleteUser ( string  userName,
dyn_string &  exceptionInfo 
)

delete a user

void fwAccessControl_createUser ( string  userName,
string  userFullName,
string  userComment,
bool  enabled,
string  password,
dyn_string  groupMembership,
dyn_string &  exceptionInfo,
int  userId = -1,
bool  passwordAlreadyCrypted = FALSE,
bool  localAccount = FALSE 
)

creates new user

bool fwAccessControl_isUserAccountLocal ( string  userName,
dyn_string &  exceptionInfo 
)

Checks if specified user account is local only

void fwAccessControl_getUserRoles ( string  userName,
dyn_string &  userRoles,
dyn_int &  roleLevels,
dyn_string &  exceptionInfo 
)
returns user's roles (groups)
Parameters
[in]userNamethe name of the user for whom the roles are queried; if empty string is passed, the current user will be assumed
[out]userRoleswill contain the list of roles for the user, i.e. the list of groups to which the user belongs
[out]roleLevelswill contain "privilege levels" associated with roles returned in userRoles; it is assumed that these privilege levels are stored in the "Comment" field of the group, as integers.
[out]exceptionInfostandard exception handling variable;
void fwAccessControl_updateUser ( string  userName,
string  newUserName,
string  userFullName,
string  userComment,
bool  enabled,
string  password,
dyn_string  groupMembership,
dyn_string &  exceptionInfo,
bool  passwordAlreadyCrypted = FALSE,
bool  localAccount = FALSE 
)

modifies a user

void fwAccessControl_enableUserAccount ( string  userName,
bool  enabled,
dyn_string &  exceptionInfo 
)
Enables/disables user account
Parameters
userNamethe name of the user
enabledindicates whether the account should be enabled or disabled
exceptionInfostandars exception handlin variable