| addUser
|
Adds a user to the system and assigns the user to the default role or group.
The user calling this method must have UpdateTransferUserRight or AdministratorRight. Super administrators can create a user and assign that user to any department. Department administrators can only create a user, and assign the user to their departments or the departments that they can manage.
|
| updateUser
|
Updates a user in the system.
The user calling this method must have UpdateTransferUserRight or AdministratorRight. Department administrators can update users assigned to their departments and the departments that they can manage. Super administrators can update any user in the system. Department administrators can change the departments to which users are assigned to their own departments or the departments that they can manage. Super administrators can change the departments to which users are assigned to any departments in the system.
Note: When performing an update, only set the fields that you want to update in the user object. The rest of the fields should be null.
To update a field to become null:
|
|
removeUser
|
Removes a user from the system.
The user calling this method must have UpdateTransferUserRight or AdministratorRight. Super administrators can delete any user in the system. Department administrators can only delete users assigned to their departments and the departments that they can manage.
|
| retrieveAllUsers
|
Retrieves all users from the system as an array of users.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null. This method returns 100 users at a time. You must keep track of the last user ID returned if you want to get the next 100 users. The first time you call this method, pass in an empty string for lastUserId.
Note: Department administrators will retrieve all users assigned to their departments and the departments that they can manage, and all public users from other departments. Super administrators will retrieve all users in the system. The user calling this method must have ViewUserRight, UpdateTransferUserRight, HelpDeskRight, or AdministratorRight.
|
| retrieveAllUsersInDept
|
Retrieves all users from the system as an array of users.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null. This method returns 100 users at a time, you must keep track of the last user ID returned if you want to get the next 100 users. The first time you call this method, pass in an empty string for lastUserId.
The user calling this method must have ViewUserRight, UpdateTransferUserRight, HelpDeskRight, or AdministratorRight.
Note: This method returns only the users assigned to a specific department. Pass in null to retrieve users not assigned to any department. Department administrators can retrieve the users assigned to their departments and the departments that they can manage. Super administrators can retrieve the users from any department in the system.
|
| searchUsers
|
Search for all users from the system associated with the search criteria as an array of users.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null.
The user calling this method must have ViewUserRight, UpdateTransferUserRight, HelpDeskRight, or AdministratorRight. For department administrators, the users assigned to their departments that meet the search criteria and the users assigned to the departments that they can manage that meet the search criteria will be returned.
|
| retrieveAllUserIds
|
Retrieves all user IDs from the system as an array of strings.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null.
|
| retrieveAllUserIds
|
Retrieves all user IDs from the department as an array of strings.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null.
Note: Passing null as department parameter will return all IDs of users not assigned to a department.
|
| retrieveUserIds
|
Retrieve user IDs as an array of strings.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null.
Note: The call is designed to meet all possible future requests for user IDs. It can also replace previous SOAP calls for user IDs. Future calls should expand this method rather than to create new SOAP calls.
|
| getUser
|
Gets a user from the system.
If the user is not found, a null is returned. The user calling this method must have ViewUserRight, UpdateTransferUserRight, HelpDeskRight, or AdministratorRight.
|
| getUsersDepartment
|
Gets a user department from the system.
If the user is not found, an exception is thrown. The user calling this method must have one of the administrative rights.
|
| changePassword
|
Updates the system password for a user.
The user calling this method must have HelpDeskRight or AdministratorRight.
|
| LDAPSyncUser
|
Synchronizes LDAP users.
|
