UpdateUserProfile API¶

Updates the profile of the specified infoRouter user, including their name, username, and authentication source.

Endpoint¶

/srv.asmx/UpdateUserProfile

Methods¶

• GET /srv.asmx/UpdateUserProfile?authenticationTicket=...&UserName=...&NewUserName=...&NewFirstName=...&NewLastName=...&AuthenticateSource=...
• POST /srv.asmx/UpdateUserProfile (form data)
• SOAP Action: http://tempuri.org/UpdateUserProfile

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 update user profiles.

Example¶

GET Request (rename user)¶

GET /srv.asmx/UpdateUserProfile
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &UserName=jdoe
  &NewUserName=john.doe
  &NewFirstName=John
  &NewLastName=Doe
  &AuthenticateSource=native
HTTP/1.1

GET Request (update name only, keep username)¶

GET /srv.asmx/UpdateUserProfile
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &UserName=jdoe
  &NewUserName=jdoe
  &NewFirstName=Jonathan
  &NewLastName=Doe
  &AuthenticateSource=native
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&UserName=jdoe
&NewUserName=john.doe
&NewFirstName=John
&NewLastName=Doe
&AuthenticateSource=native

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateUserProfile>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:UserName>jdoe</tns:UserName>
      <tns:NewUserName>john.doe</tns:NewUserName>
      <tns:NewFirstName>John</tns:NewFirstName>
      <tns:NewLastName>Doe</tns:NewLastName>
      <tns:AuthenticateSource>native</tns:AuthenticateSource>
    </tns:UpdateUserProfile>
  </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;
}

Renames a user and sets their first and last name.

await call('UpdateUserProfile', {
  authenticationTicket: ticket,
  UserName: 'jsmith',          // who to change
  NewUserName: 'jsmith2',      // send the same name again to change only the rest
  NewFirstName: 'Jane',
  NewLastName: 'Smith-Garcia',
  AuthenticateSource: 'INFOROUTER',
});

NewUserName is the account name, and changing it takes effect at once: the old name stops resolving and every later call has to use the new one. Send the existing name to leave it alone.

Notes¶

• To keep the current username, pass the same value in both UserName and NewUserName.
• If NewUserName differs from UserName, it must not conflict with an existing username.
• The AuthenticateSource determines how the user authenticates: native uses infoRouter's built-in password authentication, other values refer to configured LDAP, OAuth, or Windows domain authorities.
• To update the user's email address, use UpdateUserEmail.
• To update notification preferences, use UpdateUserPreferences.
• The user's status and type are never changed by this call; use ChangeUserStatus and ChangeUserType. On the sysadmin account those two refuse with 4030 "This is a system account and cannot be changed.", and the operation behind this call refuses the same way if it is ever asked to change them.

Related APIs¶

• GetUser - Get current user profile properties
• UpdateUserEmail - Update the user's email address
• UpdateUserPreferences - Update notification and display preferences
• CreateUser - Create a new user

Error Codes¶

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