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}}


/ session / guestGetSessionInfo


Invoke this operation to obtain session information relating to a guest account associated with an application. Guest login’s are used by web applications that require some interaction with the core application logic. This operation allows a web application to establish a working context based on the security model that is defined when creating the web application instance. If a session is already established the operation will return information about the application session. If there is no session, then an anonymous session will be established and information about that will be returned to the caller. If you are already logged in as a full user, this operation will fail.

API Details

  • Status:
  • The required privilege level to invoke this method is none
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The guestGetSessionInfo 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
portalId accountIdType Required The portal ID for which you wants to get session information for.
returnPortalOptions xs:boolean Optional
Set this to true if you want to retrieve portal options. Default is false as this adds a performance hit so should only be used sparingly.

Response Parameters

Name Type Attributes Description
sessionId xs:string Required The newly created session identifier. This is a string value that uniquely identifies the session you have just created
guestRole guestRoleType Required Returns either ‘anonymous’ or ‘authenticated’.
ssoProfile xs:string Optional The name of a guest single-sign-on profile to use for guest access.
allowSelfServicePasswordReset xs:boolean Optional Returns ‘true’ if password resets are allowed on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
allowGuestSelfRegistration xs:boolean Optional Returns ‘true’ if guest self-registrations allowed on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
needGuestSelfRegistrationAuthorization xs:boolean Optional Returns ‘true’ if guest registration authorisation is required on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
allowGuestSelfRegistrationOrgSetting xs:boolean Optional Returns ‘true’ if contacts can choose their organization when registering themselves on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
In This Document