DeleteUser API
Deletes the specified infoRouter user account. If the system is configured to require password confirmation for user deletion, this method will fail and DeleteUser1 must be used instead.
Endpoint
/srv.asmx/DeleteUser
Methods
- GET
/srv.asmx/DeleteUser?authenticationTicket=...&UserName=... - POST
/srv.asmx/DeleteUser(form data) - SOAP Action:
http://tempuri.org/DeleteUser
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser. |
UserName |
string | Yes | The username to delete, or a short ID reference in the format ID:userid (e.g., ID:123). |
Response
Success Response
<response success="true" error="" />
Error Response
<response success="false" error="[ErrorCode] Error message" />
Required Permissions
System administrator. Only system administrators can delete user accounts.
Example
GET Request (by username)
GET /srv.asmx/DeleteUser
?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&UserName=jdoe
HTTP/1.1
GET Request (by user ID)
GET /srv.asmx/DeleteUser
?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&UserName=ID:123
HTTP/1.1
POST Request
POST /srv.asmx/DeleteUser HTTP/1.1
Content-Type: application/x-www-form-urlencoded
authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&UserName=jdoe
SOAP Request
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tns="http://tempuri.org/">
<soap:Body>
<tns:DeleteUser>
<tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
<tns:UserName>jdoe</tns:UserName>
</tns:DeleteUser>
</soap:Body>
</soap:Envelope>
Notes
- The
UserNameparameter accepts either a plain username string (e.g.,jdoe) or a short ID reference in the formatID:userid(e.g.,ID:123). - If the system is configured to require administrator password confirmation for user deletion (
PasswordRePromptActions.UserDelete = true) and Windows Authentication is not enabled, this method returns error[2767]and requiresDeleteUser1instead. - Deleting a user is permanent and cannot be undone.
- Before deleting a user, consider using the
TransferUser*APIs to transfer the user's data (documents, tasks, subscriptions) to another user.
Related APIs
- DeleteUser1 - Delete a user with administrator password confirmation
- UserExists - Check if a user exists before attempting deletion
- TransferUserDocumentOwnerships - Transfer document ownerships before deletion
- TransferUserTasks - Transfer workflow tasks before deletion
- ChangeUserStatus - Disable a user account without deleting it
Error Codes
| Error | Description |
|---|---|
[900] Authentication failed |
Invalid or missing authentication ticket. |
[901] Session expired or Invalid ticket |
The ticket has expired or does not exist. |
[2767] |
Password confirmation required — use DeleteUser1 instead. |
| User not found | The specified username does not exist. |
| Access denied | The calling user is not a system administrator. |
SystemError:... |
An unexpected server-side error occurred. |
For detailed documentation visit: https://support.inforouter.com/api-docs/DeleteUser