Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

API Services / admin

  • Article
  • 3 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.
contactSetAuthentication Invoke this method to set the authentication value for the specified 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.
userDeleteProps Delete one or more named extensible properties from a user account. Properties that don’t exist on the user are…
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.
userGetProps Return the extensible properties currently set on a user account. With no name filter the full list is returned; if…
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.
userSetProps Upsert one or more extensible properties on a user account. Each entry is created if no row with the same (userId,…
userUpdate Invoke this method to update one or more user properties.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document