Documentation Library

Search for information on Hornbill Documentation.


{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Operation Information

Retrieves the details about an Active Directory User account.

Input Parameters

Name Type Description Required Sensitive
UserIdentity string The Identity of the User (distinguished, objectGUID, objectSid or sAMAccountName) Yes No
Server string The Active Directory Domain Services instance to perform the operation against No No

Output Parameters

Name Type Description Required Sensitive
errors string Any errors returned by the operation No No
outcome string Outcome of the operation. Can be OK or FAIL Yes No
AccountExpirationDate string Account Expiration Date No No
BadLogonCount string Bad Logon Count No No
badPwdCount string Bad Pwd Count No No
CannotChangePassword string Cannot Change Password No No
CanonicalName string Canonical Name No No
City string City No No
CN string CN No No
Company string Company No No
Country string Country No No
countryCode string Country Code No No
Department string Department No No
Description string Description No No
DisplayName string Display Name No No
DistinguishedName string Distinguished Name No No
Division string Division No No
EmailAddress string Email Address No No
EmployeeID string Employee I D No No
EmployeeNumber string Employee Number No No
Enabled string Enabled No No
GivenName string Given Name No No
HomeDirectory string Home Directory No No
HomeDrive string Home Drive No No
HomePage string Home Page No No
HomePhone string Home Phone No No
Initials string Initials No No
isDeleted string Is Deleted No No
LastLogonDate string Last Logon Date No No
LockedOut string Locked Out No No
Manager string Manager No No
MemberOf string Member Of No No
MobilePhone string Mobile Phone No No
Modified string Modified No No
modifyTimeStamp string Modify Time Stamp No No
Name string Name No No
ObjectGUID string Object G U I D No No
objectSid string Object Sid No No
Office string Office No No
OfficePhone string Office Phone No No
Organization string Organization No No
OtherName string Other Name No No
PasswordExpired string Password Expired No No
PasswordLastSet string Password Last Set No No
PasswordNeverExpires string Password Never Expires No No
PasswordNotRequired string Password Not Required No No
POBox string P O Box No No
PostalCode string Postal Code No No
PrimaryGroup string Primary Group No No
ProfilePath string Profile Path No No
ProtectedFromAccidentalDeletion string Protected From Accidental Deletion No No
SamAccountName string Sam Account Name No No
sn string Sn No No
State string State No No
StreetAddress string Street Address No No
Title string Title No No
uid string Uid No No
userAccountControl string User Account Control No No
UserPrincipalName string User Principal Name No No
whenChanged string When Changed No No
whenCreated string When Created No No
In This Document