Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ admin / userGetInfo

  • Article
  • 3 minutes to read

Description

Invoke this operation to obtain user properties for the specified user.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is slave
System Rights Database Rights Mail Rights Calendar Rights
sys.a.manageUsers
 --- --- ---

Request Parameters

The userGetInfo method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
userId accountIdType Optional The ID of the user. You must specifiy this or accountSelector
accountSelector userAccountSelectType Optional The account selector. You must specifiy this or userId
wantExtendedUserProfile xs:boolean Optional
Default=true		 Set this to true if you want to return the extended user profile information. This will only work for full system user accounts.

Response Parameters

Name Type Attributes Description
userId xs:string Required The unique login ID for this account (this is the primary key)
loginId loginIdType Required The login ID for this user account
employeeId accountIdType Required The Employee ID for this user account
userType accountUserType Required The type of user, either ‘user’ or ‘basic’ or ‘msp’.
nonUserAccount xs:boolean Optional If set to ‘true’ the account will not be visible in user browse/search lists.
enable2fa twofaMethodType Optional The two-factor authentication method used when logging in via Hornbill Direct Login.
name nameType Required The display name of the user.
firstName nameType Optional The first name of the user.
lastName xs:string Optional The last name of the user.
jobTitle xs:string Optional The job title of the user.
homeOrganization groupIdType Optional The home organization of the user.
site xs:string Optional The site this user is based at.
phone xs:string Optional The direct dial telephone number for the user.
email rfc822AddressType Optional The email for the user.
mobile xs:string Optional The cell phone number for the user (used for SMS notification).
availabilityStatus numberType Required The availability status currently set for this user.
availabilityStatusTime xs:dateTime Optional The date/time the availability status was set.
absenceMessage xs:string Optional The absence message for this user.
timeZone xs:string Optional The default Time Zone applied to this user. If you want to get a list of timezones, please see the time::getTimezoneList.
language xs:language Optional The assigned language of the user.
dateTimeFormat xs:string Optional The default date/time format of the user.
dateFormat xs:string Optional The default date format of the user.
timeFormat xs:string Optional The default time format of the user.
currencySymbol xs:string Optional The default currency symbol to use.
countryCode countryCodeType Optional The default country code of the user.
lastLogonTime xs:dateTime Optional The last logon time for the user.
lastKnownLocation geoLocationType Optional The location information for the user.
notifyEmail xs:boolean Optional Indicates notifications to this users e-mail address are enabled/disabled.
notifyTextMessage xs:boolean Optional Indicated notifications to this users mobile phone via SMS text messages are enabled/disabled.
onlineStatus onlineStatusType Optional The online status of a user.
accountStatus accountStatusType Required The status of the specified user.
imageReference xs:string Optional A reference to the profile image associated with this account.
createdOn xs:dateTime Required The date/time this user account was created.
createdBy xs:string Required The person who created this user account.
lastUpdatedOn xs:dateTime Optional The last time this user account was updated.
lastUpdatedBy xs:string Optional The person who last updated this user account.
userProfile userExtendedProfileData Optional If a full user and extended profile information was requested, this property will contain the extended user profile properties.
securityOptions userAccountSecurityOptionsType Optional Security options applied to this account.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document