ChangeUserType API¶

Changes the type of the specified infoRouter user account between author and read-only user.

The change is read back from GetUser, which reports UserType - the same number this operation takes - beside the older ReadOnlyUser boolean, in detail mode. Until 9.0 it carried neither the number nor anything else naming the type, so a change made here could not be confirmed; GetAllUsers2 can filter on it but still does not report it.

0 (Unspecified) is refused: a user is an author or a reader. The refusal names both values.

Endpoint¶

/srv.asmx/ChangeUserType

Methods¶

• GET /srv.asmx/ChangeUserType?authenticationTicket=...&userName=...&userType=...
• POST /srv.asmx/ChangeUserType (form data)
• SOAP Action: http://tempuri.org/ChangeUserType

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 change user account types.

Example¶

GET Request (change to author)¶

GET /srv.asmx/ChangeUserType
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &userName=jdoe
  &userType=1
HTTP/1.1

GET Request (change to read-only)¶

GET /srv.asmx/ChangeUserType
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &userName=jdoe
  &userType=2
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&userName=jdoe
&userType=2

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:ChangeUserType>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:UserName>jdoe</tns:UserName>
      <tns:UserType>2</tns:UserType>
    </tns:ChangeUserType>
  </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;
}

Marks a user as an author or a reader.

await call('ChangeUserType', { authenticationTicket: ticket, userName: 'jsmith', userType: 1 }); // author
await call('ChangeUserType', { authenticationTicket: ticket, userName: 'jsmith', userType: 2 }); // reader

Notes¶

• Author users (type 1) can upload, edit, and manage documents based on their permissions.
• Read-only users (type 2) can only view and download documents; they cannot upload or edit.
• Changing a user to read-only does not remove their existing document ownership or folder memberships.
• The ReadOnlyUser attribute in GetUser responses reflects the current user type.

Related APIs¶

• GetUser - Get current user properties including user type
• ChangeUserStatus - Enable or disable a user account
• CreateUser - Create a new user with a specified type

Error Codes¶

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