Delete User
deleteUser
This web service permanently deletes a user from the Portal. Once deleted, the userID may never be reused again. (It is not possible to delete and then re-create the same user.) Therefore if it is likely that this very same user will need to be re-activated in the future, then the user should be locked out (disabled) so that he may be later unlocked (enabled) again.
void deleteUser(string companyId, string userId) throws WSException
- companyId: (optional) A string of maximum length 10 that specifies the unique company identifier. Will default to the authorized user's company if not specified.
- userId: A string of maximum length 10 that identifies the user to delete.
Authorization Requirements
The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.
Required Application Licenses
- Remote Integration
Required User Permissions
- Admin role
Customer integrators are authorized to their own company's data only.
Sample XML Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample XML Response
|
|
Exceptions
001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Valid user cannot be found with specified information.
006 Cannot delete user.
007 User is the Trailer Tracks system administrator. Change system administrator and then delete user. (Coming soon... approximately February 2017)