Get User


Retrieve information about a user.

If the combination of userLogonReference (user id) and password is valid, return the user name.

If not, return the not authorised error.

Update the lastSignOnTimestamp property with the current timestamp.

This service is used to sign the user on. To get details of other users, use the GetUserDetails service.



Set the <signOn> element to true to indicate a user is signing on to the application. Set to false to indicate that a user credentials are being checked but no sign on is taking place. Default is true.


<errorNumber>0</errorNumber> <userLogonReference>userid</userLogonReference>
<userName>The User Name</userName>
<userEmailAddress>email address</userEmailAddress>
<userCapabilities>token1 token2 etc</userCapabilities>
<acceptThirdPartyMarketingIndicator>true|false</acceptThirdPartyMarketingIndicator> <forcePasswordChangeIndicator>true|false</forcePasswordChangeIndicator> <clientIdentificationString>client id string</clientIdentificationString> <signOnURL>sign on URL</signOnURL>

userLogonReference is returned because the service may be called using a session token.

userCapabilities is a list of permission types references that the user has, separated by spaces. The purpose of userCapabilities is to allow the user interface to be tailored to different users.  The services called from the user interface should still check that the user is authorised.

mayUpdateProfile indicates if the user may update their own profile. This can be because they have the maintain-profile permission (which will be present in userCapabilities) or if they have a suitable permission on their own owning user group.

clientIdentificationString and signOnURL are only returned if the service is called with a session token in place of userLogonReference and password. Only non-blank fields are returned.

If the user is a proxy user, the userName, userEmailAddress, acceptMarketingIndicator and acceptThirdPartyMarketingIndicator are returned from the main user record.

If signOn is false, userCapabilities, forcePasswordChange and signOnURL are not returned, and the sign on is not logged.


101 - Not authorised

When error 101 is returned, the service will also return signOnURL if available. This is the URL to which the user should be redirected in order to sign on.