GetUser

# GetUser API

Returns the detailed properties of the specified infoRouter user, including profile information, authentication source, and notification preferences.

Endpoint¶

/srv.asmx/GetUser

Methods¶

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

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`UserName`	string	Yes	The username to look up. If empty or omitted, returns the properties of the currently authenticated user.

Response¶

Success Response¶

Returns a <User> element nested inside the <response> element with full user detail attributes and a <Preferences> child element.

<response success="true" error="">
  <User exists="true"
        UserID="123"
        FirstName="John"
        LastName="Doe"
        Email="john.doe@example.com"
        Enabled="TRUE"
        UserName="jdoe"
        Domain="Finance"
        LastLogonDate="2024-01-15"
        LastPasswordChangeDate="2024-01-01"
        AuthenticationAuthority="native"
        ReadOnlyUser="FALSE">
    <Preferences Language="English"
                 DefaultPortal=""
                 ShowArchives="FALSE"
                 ShowHiddens="FALSE"
                 NotificationType="INSTANT"
                 NotificationTypeId="1"
                 EmailType="HTML"
                 AttachDocumentToEmail="FALSE" />
  </User>
</response>

Error Response¶

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

User Element Attributes¶

Attribute	Description
`exists`	Always `true` when the user is found.
`UserID`	Unique numeric ID of the user.
`FirstName`	User's first name.
`LastName`	User's last name.
`Email`	User's email address.
`Enabled`	`TRUE` if the account is active; `FALSE` if disabled.
`UserName`	The user's login name.
`Domain`	The default domain/library associated with the user.
`LastLogonDate`	Date of the user's last successful login.
`LastPasswordChangeDate`	Date the user's password was last changed.
`AuthenticationAuthority`	Authentication source: `native`, a Windows domain name, or a configured LDAP/OAuth authority.
`ReadOnlyUser`	`TRUE` if the user is a read-only user; `FALSE` if an author.

Preferences Element Attributes¶

Attribute	Description
`Language`	The user's preferred display language.
`DefaultPortal`	The user's default portal name, if set.
`ShowArchives`	`TRUE` if the user sees archived domains in listings.
`ShowHiddens`	`TRUE` if the user sees hidden domains in listings.
`NotificationType`	Notification delivery mode: `NONE`, `INSTANT`, or `DAILY REPORT`.
`NotificationTypeId`	Numeric ID corresponding to `NotificationType`.
`EmailType`	Email format preference: `HTML` or `TEXT`.
`AttachDocumentToEmail`	`TRUE` if documents are attached to notification emails.

Required Permissions¶

Any authenticated user can call this API. Non-administrators can only retrieve their own user info or users they have access to view. If UserName is omitted or empty, the current user's own properties are returned.

Example¶

GET Request (specific user)¶

GET /srv.asmx/GetUser
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &UserName=jdoe
HTTP/1.1

GET Request (current user)¶

GET /srv.asmx/GetUser
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &UserName=
HTTP/1.1

POST Request¶

POST /srv.asmx/GetUser 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:GetUser>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:UserName>jdoe</tns:UserName>
    </tns:GetUser>
  </soap:Body>
</soap:Envelope>

Notes¶

If UserName is null or whitespace, the API returns the properties of the currently authenticated user.
To retrieve only basic user identity (without preferences), use GetAllUsers1 or GetCoWorkers1 with appropriate filters.
To check whether a user exists without retrieving full details, use UserExists.

UserExists - Check if a user exists
GetAllUsers - Get a list of all users
UpdateUserProfile - Update user profile information
UpdateUserEmail - Update the user's email
UpdateUserPreferences - Update user preferences

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.
User not found	The specified username does not exist.
`SystemError:...`	An unexpected server-side error occurred.

For detailed documentation visit: https://support.inforouter.com/api-docs/GetUser