The User web service contains methods that provide access to User data and related information.
Sample Code: controls/AuthControl.aspx
AddCustomerAccess
Adds access to customer for user.
AuthorizeUser
This method is used to verify that the User is authorized to access the given Customer account. It returns an indicator that specifies whether sLoginName is authorized for the sCustID being passed in. The bAuthorized node will be set to true if LoginName is authorized for customer or false if LoginName is not authorized.
CreateUser
Creates a User with the given information and returns information about the newly created User. If the bUserCreated element is ‘true’, the User was successfully created.
EditUser
Edits a User with the given information. If the bUpdated element is ‘true’, the User was successfully updated.
GetUserDetail
Returns detailed information for the given sLoginName.
GetUsers
Returns a list of the users associated with the sCustID passed in. The Xml Response may contain multiple User nodes.
GetUsersByType (*)
Returns a list of the users associated with the sCustID passed in for the requested user type. The Xml Response may contain multiple User nodes.
RemoveCustomerAccess
Removes access to customer for user.
SuspendUser
Suspends the user.
UpdatePassword
This method will change the password of the given user. It returns an indicator that specifies whether the password has been updated. The bPasswordChanged node will be set to true if Password is changed for LoginName or false if Password is not changed.
Additional information, including each methods response XML structure, is provided in the documentation and more example code is provided in the Gateway Sample application.