DeleteUser1 API¶

Deletes the specified infoRouter user account with administrator password confirmation. Use this API instead of DeleteUser when the system requires password re-prompting for user deletion.

UserPassword is always checked. It is the caller's own password, not the password of the user being deleted, and a wrong one refuses the delete with 4030. Use DeleteUser when no confirmation is wanted.

With Windows authentication there is no infoRouter password to confirm, and the parameter is not read.

Endpoint¶

/srv.asmx/DeleteUser1

Methods¶

• GET /srv.asmx/DeleteUser1?authenticationTicket=...&UserPassword=...&UserName=...
• POST /srv.asmx/DeleteUser1 (form data)
• SOAP Action: http://tempuri.org/DeleteUser1

Parameters¶

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

An administrator's account (the sysadmin account or a member of [Administrators]) can be changed by administrators only; anyone else is refused with 4030. See AdministrativeRoles.

System administrator. Only system administrators can delete user accounts.

Example¶

GET Request¶

GET /srv.asmx/DeleteUser1
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &UserPassword=AdminP%40ssword
  &UserName=jdoe
HTTP/1.1

POST Request¶

POST /srv.asmx/DeleteUser1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&UserPassword=AdminP@ssword
&UserName=jdoe

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:DeleteUser1>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:UserPassword>AdminP@ssword</tns:UserPassword>
      <tns:UserName>jdoe</tns:UserName>
    </tns:DeleteUser1>
  </soap:Body>
</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Deletes a user, re-prompting for the caller's own password first.

await call('DeleteUser1', {
  authenticationTicket: ticket,
  UserPassword: callersOwnPassword,
  UserName: 'jsmith',
});

Notes¶

• The UserPassword is the password of the calling administrator, not the user being deleted, and it is verified on every call. Re-prompting is the whole difference between this operation and DeleteUser.
• If the system does not require password confirmation (PasswordRePromptActions.UserDelete = false), both DeleteUser and DeleteUser1 work; you may use either.
• Deleting a user is permanent and cannot be undone.
• Before deleting a user, consider using the TransferUser* APIs to reassign the user's data (documents, tasks, subscriptions, memberships) to another user.

Related APIs¶

• DeleteUser - Delete a user without password confirmation (when allowed)
• UserExists - Check if a user exists before attempting deletion
• TransferUserDocumentOwnerships - Transfer document ownerships before deletion
• TransferUserTasks - Transfer workflow tasks before deletion

Error Codes¶

The errorCode values this operation returns, checked against a running server: