WEBfactory WCF UserService Documentation
This article provides all the needed information to learn and understand the WCF UserService documentation.
This WCF web service handles all the User related operations. The following methods are available:
GetCurrentUserDetails(string sessionId, string clientId)
Syntax |
|
Description | Retrieves all available details about the currently logged in user |
Parameters |
|
Return Value | The UserDetailsDTO object, containing:
|
GetAllUsers(string sessionId, string clientId, string userName, bool isDomainUser, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol. Read the Security note for more information.
Syntax |
|
Description | Retrieves all the WEBfactory users |
Parameters |
|
Return Value | A list of UserDTO objects, each containing:
|
GetAllUsersByToken(string securityToken, int millisecondsTimeOut)
Syntax |
|
Description | Retrieves all the WEBfactory users using the security token |
Parameters |
|
Return Value | A list of UserDTO objects, each containing:
|
GetAllUserDetails(string sessionId, string clientId, string userName, bool isDomainUser, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol. Read the Security note for more information.
Syntax |
|
Description | Retrieves all the WEBfactory user details for all existing users |
Parameters |
|
Return Value | A list of UserDetailsDTO objects, each containing:
|
GetAllUserDetailsByToken(string securityToken, int millisecondsTimeOut)
Syntax |
|
Description | Retrieves all the WEBfactory user details for all existing users, using the security token |
Parameters |
|
Return Value | A list of UserDetailsDTO objects, each containing:
|
GetAllUsersWithSameAuthorizationGroups(string sessionId, string clientId, string userName, bool isDomainUser, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol. Read the Security note for more information.
Syntax |
|
Description | Retrieves all the WEBfactory users which have the same authorization groups |
Parameters |
|
Return Value | A list of UserDTO objects, each containing:
|
GetAllUsersWithSameAuthorizationGroupsByToken(string securityToken, int millisecondsTimeOut)
Syntax |
|
Description | Retrieves all the WEBfactory users that have the same authorization groups using the security token |
Parameters |
|
Return Value | A list of UserDTO objects, each containing:
|
GetAllUserDetailsWithSameAuthorizationGroups(string sessionId, string clientId, string userName, bool isDomainUser, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Retrieves all the WEBfactory user details for all users that have the same authorization groups |
Parameters |
|
Return Value | A list of UserDetailsDTO objects, each containing:
|
GetAllUserDetailsWithSameAuthorizationGroupsByToken(string securityToken, int millisecondsTimeOut)
Syntax |
|
Description | Retrieves all the WEBfactory user details for all users that have the same authorization groups, using the security token |
Parameters |
|
Return Value | A list of UserDetailsDTO objects, each containing:
|
InsertUser(string sessionId, string clientId, string userName, bool isDomainUser, UserDTO model, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Adds a new user based on the provided model |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
InsertUserByToken(string securityToken, UserDTO model, int millisecondsTimeOut)
Syntax |
|
Description | Adds a new user based on the provided model and security token |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
UpdateUser(string sessionId, string clientId, string userName, bool isDomainUser, UserDTO model, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Updates an existing user based on the provided model |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
UpdateUserByToken(string securityToken, UserDTO model, int millisecondsTimeOut)
Syntax |
|
Description | Updates an existing user based on the provided model and security token |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
DeleteUser(string sessionId, string clientId, string userName, bool isDomainUser, Guid id, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Deletes an existing user based on the provided ID |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
DeleteUserByToken(string securityToken, Guid id, int millisecondsTimeOut)
Syntax |
|
Description | Deletes an existing user based on the provided ID and security token |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
ChangeUserPassword(string sessionId, string clientId, string userName, bool isDomainUser, Guid affectedUserId, string newPassword, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Changes the password of an existing user based on the provided ID |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
ChangeUserPasswordByToken(string securityToken, Guid affectedUserId, string newPassword, int millisecondsTimeOut)
Syntax |
|
Description | hanges the password of an existing user based on the provided ID and security token |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
ChangeCurrentUserPassword(string sessionId, string clientId, string userName, bool isDomainUser, string currentPassword, string newPassword, int millisecondsTimeOut)
This method follows the WEBfactory Security Protocol.
Syntax |
|
Description | Changes the password of the currently logged in user based on the provided parameters |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |
ChangeCurrentUserPasswordByToken(string securityToken, string currentPassword, string newPassword, int millisecondsTimeOut)
Syntax |
|
Description | Changes the password of the currently logged in user based on the provided ID and security token |
Parameters |
|
Return Value | The status of the operation: true for success or false for error |