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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{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 docs@hornbill.com.

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 docs.hornbill.com 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 docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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...

API Services / admin

  • Article
  • 2 minutes to read

Description

This service provides the system administration related operations.

Methods

Method Status Type HTTP Method Description
appOptionGet Invoke this method to get one or more application options and their associated values.
contactCreate Invoke this method to create a contact.
contactDelete Invoke this method to archive or permenantly delete a contact record.
contactSetAuthentication Invoke this method to set the authentication value for the specified contact record.
contactUpdate Invoke this method to update a contact record.
getApplicationList Invoke this operation to get a list of ESP applications that are installed on the server. If you want to get a…
groupCreate Invoke this operation to create new user group.
groupGetInfo Invoke this operation to obtain the properties of the specified user group.
groupGetList2 Invoke this operation to get a list of groups
groupGetUserList Invoke this operation to obtain a list of user accounts assigned to the specified group.
groupSetInfo Invoke this operation to update the properties of the specified user group.
sysOptionGet Invoke this method to get one or more application options and their associated values.
userAddGroup Invoke this operation to add a group membership to the specified user.
userAddRole Invoke this operation to assign one or more roles to the specified user. When adding one or more roles for the…
userCreate Invoke this method to create a user.
userDelete Invoke this method to delete a user from the system.
userDeleteGroup Invoke this operation to remove group membership from the specified user.
userGetGroupList Invoke this operation to obtain a list of groups assigned to the specified user account.
userGetInfo Invoke this operation to obtain user properties for the specified user.
userGetList Invoke this operation to get a list of user defined on the system.
userProfileGetList Invoke this operation to get a list of user profiles
userProfileSet Invoke this method to update user profile data
userRemoveRole Invoke this operation to remove one or more role assignments from the specified user. When removing one or more roles…
userSetAccountStatus This operation sets the account status of the specified user.
userSetAvailability Invoke this operation to change the availability status for the specified user.
userUpdate Invoke this method to update one or more user properties.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document