Service Info: admin


Service Description

This service provides the system administration related operations.

Available Operations

The following operations are available for the admin service. You can click on each operation to see detailed information about that operation.

Operation Description
appApplySchema Invoke this operation to apply the schema for the installed application(s).
appGetUpdateHistory Invoke this operation to get a history of update actions/events for a given application
appInstall Installs an application package onto the ESP server. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
appOptionGet Invoke this method to get one or more application options and their associated values.
appOptionGetDescription Invoke this method to get the text description for the specified application option. This information can be used to provide the user with a description of the option and its purpose.
appOptionGetList Invoke this method to get one or more application options and their associated values and extended information including description and default value.
appOptionSet Invoke this method to set one or more application options. Options set here are applied to all users. To set user-specific options, use the operation session::setApplicationOption
appRightsGetMeta This operation gets the application rights meta data.
appStoreListApplications Invoke this operation to get a list of applications that are available in the specified app store.
appStoreListStores Invoke this operation to get a list of applications that are available in the specified app store.
appStringGet Invoke this method to get one or more application strings.
appStringGetGroups Invoke this method to get a distinct list of string groups.
appStringSet Invoke this method to set one or more application strings.
appSubscriptionGetUsage Invoke this operation to get the subscription usage for all the applications deployed on this instance
appSubscriptionUserAdd Invoke this operation to add one or more users to the specified application
appSubscriptionUserGetList2 Invoke this operation to get a list of subscribed users who can use the specified application.
appSubscriptionUserRemove Invoke this operation to remove one or more users currently allowed to use the application.
appUninstall Remove all traces of the specified application from the ESP server. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
appUpdate Updates an existing application to the latest ot the specified build. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
applicationCacheReload Invoke this method to force the system to reload the application metadata cache for the specified application(s). The system may not flush the metadata immediately if the currently loaded metadata is in use by other transactions.
autoValueCreate Invoke this method to create a new auto value generator. WARNING: If the auto value generator already exists is will be reset. If you need to create an auto value but not reset it if it already exists, then use the admin::autoValueUpdate operation instead.
autoValueDelete Invoke this method to delete an auto value generator.
autoValueGetInfo Invoke this method to get the properties of an existing auto value generator.
autoValueList Invoke this method to obtain a list of auto value generators defined on the system.
autoValueSet Invoke this method to reset the value for the sequence component of an existing auto value generator. If the sequence component doesn't exist in the auto value definition then it will be ignored.
autoValueUpdate Invoke this method to update an existing auto value generator. If the auto value does not exist then it will be created. Auto value sequence numbers in the existing auto values are not reset by invoking this operation. If you want to reset the auto value counters then you should use the admin::autoValueCreate operation instead.
bpmIntegrationAdd Invoke this operation to create a new integration connector.
bpmIntegrationDelete Invoke this operation to delete a connector. This cannot be undone.
bpmIntegrationGet Invoke this operation to get the details about an integration connector.
bpmIntegrationGetTypeInfo Invoke this operation to get integration connector type information
bpmIntegrationList Invoke this operation to get a list of integration connectors
bpmIntegrationListTypes Invoke this operation to get a list of integrations defined
bpmIntegrationTest Invoke this operation to test the intergation connection.
bpmIntegrationUpdate Invoke this operation to update the details of the specified connector.
cafsCreate This operation creates a new CAFS store.
cafsDelete This operation deletes an existing CAFS store. Caution: Invoking this operation will delete all data stored in the CAFS store specified.
contactCreate Invoke this method to create a contact.
contactSetAuthentication Invoke this method to set the authentication value for the specified contact record.
contactUpdate Invoke this method to update a contact record.
cryptCreateSharedSecret Invoke this method to generate a new shared secret. This is used by portal applications during installation if there is a requirement to use trusted user authentication. The resultant certificate file is used by both the portal and the ESP server to authenticate a user login to the ESP server.
cryptDeleteSharedSecret Invoke this method to remove the shared secret from the key cache.
cryptGetSharedSecretData Invoke this method to read the shared secret key data.
dataCleardown PRELIMINARY DOCUMENTATION: This operation is used to permanently clear down or reset data on the instance to bring it back to a clean known state. Typically this would be used to reset the system after testing or evaluation when you want to maintain the configuration and some elements of the data but clear down any test data that was put into the system. Using this operation is destructive to any data on the system so use with caution
devAppCommit Commits any changes made to the application back to the subversion repository. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
devAppInstall Installs an application (source code) onto the ESP server from a Subversion repository. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
devAppUninstall Remove all traces of the application from the ESP server. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation.
devAppUpdate Updates an application from the subversion repository that is already installed on this ESP server. This operation is asynchronous and will return immediately. You can check the progress by calling the operation system::backgroundJobStatus operation
getApplicationInfo Invoke this operation to get information about the specified application.
getApplicationList Invoke this operation to get a list of ESP applications that are installed on the server. If you want to get a list of applications that the current user only has rights to use, please see the session::getApplicationList instead.
getEntityList Invoke this operation to get a list of entities associated with the specified application.
getInstanceAuditInfo Query instance audit information. For more information about how Hornbill measures space utilisation for the purpose of instance quota management, please read the following document: Instance Storage Quota
getInstanceSubscriptionInfo Query instance subscription information.
getSystemStatusReport Invoke this operation to get a system status report.
getTableInfo This operation gets a description of the specified table.
getTableList This operation gets a list of the tables for the specified database. You can also filter the list of tables by a given application.
groupCreate Invoke this operation to create new user group.
groupDelete Invoke this operation to delete the specified user group. If the group is associated with any role or account then this operation will fail.
groupGetInfo Invoke this operation to obtain the properties of the specified user group.
groupGetList Invoke this operation to get a list of groups defined on the system.
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.
guestTemplateCreate Invoke this method to create a guest template.
guestTemplateDelete Invoke this method to delete a guest template.
guestTemplateGet Invoke this method to get guest template details.
guestTemplateList Invoke this method to get a list of guest templates.
guestTemplateUpdate Invoke this method to update a guest template.
keysafeAddKey Invoke this operation to create a new key.
keysafeDeleteKey Invoke this operation to delete a key from the KeySafe. This cannot be undone.
keysafeGetKey Invoke this operation to get the details of a key.
keysafeGetTypeInfo Invoke this operation to get a type information for the keys stored in the Hornbill KeySafe
keysafeListKeys Invoke this operation to get a list of keys stored in the Hornbill KeySafe
keysafeListTypes Invoke this operation to get a list of key types stored in the Hornbill KeySafe
keysafeUpdateKey Invoke this operation to update the details of this key.
mailRightsGetMeta This operation gets the system rights meta data.
portalAccountCreate Invoke this method to create a new portal account on the system.
portalAccountDelete Invoke this method to delete one or more portal accounts.
portalAccountGetContacts Invoke this operation to get a list of authorised contacts for the specified portal.
portalAccountGetInfo Invoke this operation to obtain portal properties for the specified portal account on the system.
portalAccountGetList Invoke this method to obtain a list of portal accounts set up on this system and optionally filter by application.
portalAccountSetInfo Invoke this method to update one or more portal account properties.
portalAuthorizedRoleAdd Invoke this operation to assign one or more authorized roles to the specified portal account.
portalAuthorizedRoleRemove Invoke this operation to remove one or more authorized role assignments from the specified portal account.
portalSetContactAccess Invoke this operation to set the access status for one or more contacts.
profileCodeSetCreate Invoke this operation to create a profile code set.
profileCodeSetDelete This operation deletes the profile code set.
profileCodeSetSetInfo This operation set the profile code set properties.
resetProcessLoggingOptions This operation causes the process to reset its logging options to the currently defined logging configuration. This operation is generally called by the administration tool in order to apply changes to the logging options without the need to restart the service
roleAddMailbox Invoke this operation to provide access to a shared mailbox for the specified admin/security role and optionally set the mailbox rights.
roleCopy Invoke this operation to make a copy of an existing role.
roleCreate Invoke this operation to create a new admin/security role.
roleCreateAssignment Invoke this operation to create a new assignment role.
roleDelete Invoke this operation to delete the specified role.
roleDeleteApplication Invoke this operation to disassociate an application with the specified role.
roleExists Invoke this operation to check to see if the specified role exists.
roleGetApplicationList Invoke this operation to obtain a list of applications assigned to the specified role.
roleGetDatabaseRights Invoke this operation to get the database rights granted to the specified role.
roleGetInfo Invoke this operation to obtain the properties of the specified role.
roleGetList Invoke this operation to get a list of roles defined on the system.
roleGetMailboxList Invoke this operation to return the list of shared mailboxes and its rights assigned to the specified role.
roleGetUserList Invoke this operation to get a list of basic or normal user accounts assigned to the specified role. Portal accounts are excluded
roleRemoveMailbox Invoke this operation to remove shared mailbox access from the specified admin/security role.
roleSetApplicationRights Invoke this operation to set application rights for the specified admin/security role. If you want to leave rights flags unchanged, simply do not specify that flag.
roleSetDatabaseRights Invoke this operation to set database rights for the specified admin/security role. If you want to leave rights flags unchanged, simply do not specify that flag.
roleSetInfo Invoke this operation to update an existing admin/security role.

USAGE NOTES:
  • Any optional values are left unchanged if not specified
  • When setting the rights, if a given right is specified it is set or cleared for the role depending on the boolean value specified. Each right that you do not specify will be left unchanged from its current state.
roleSetMailboxRights Invoke this operation to set shared mailbox rights for the specified admin/security role. If you want to leave rights flags unchanged, simply do not specify that flag.
roleUpdateAssignment Invoke this operation to update an existing assignment role.
securityAuditGetList Invoke this operation to get a list of security audit events.
sessionClear Clears the specified session(s). Forcefully closes open connections relating to the specified session(s).
sessionGetList Gets a list of currently active sessions on the system.
ssoAuthProfileAddKey This operation is used to add a new certificate to a single-sign-on authentication profile.
ssoAuthProfileCreate This operation is used to create a new single-sign-on authentication profile. In order to use SSO, a profile needs to be created to tell the system information about the trusted identity provider.
ssoAuthProfileDelete This operation is used to one or more SSO authentication profiles defend on this instance
ssoAuthProfileDeleteKey This operation is used to delete a certificate to a single-sign-on authentication profile.
ssoAuthProfileGet This operation is used to get information about a single-sign-on authentication profile.
ssoAuthProfileList This operation is used to get a list of SSO authentication profiles defined on this instance
ssoAuthProfileUpdate This operation is used to update an existing single-sign-on authentication profile.
ssoGuestAttributes This operation is used to get a list of guest account attributes that the instance can receive from an SSO authentication request
ssoUserAttributes This operation is used to get a list of user account attributes that the instance can receive from an SSO authentication request
sysNetworkRulesChangeOrder This operation is used to change the priority order of an Network Rules.
sysNetworkRulesCreate Invoke this operation to get a list of Network IP Access Rules.
sysNetworkRulesDelete Invoke this operation to delete a given Network Rule.
sysNetworkRulesGet Invoke this operation to return a given Network Rule.
sysNetworkRulesList Invoke this operation to get a list of Network IP Access Rules.
sysNetworkRulesTest Invoke this operation to test a Client IP Address against the current Network Rules.
sysNetworkRulesUpdate Invoke this operation to update a given Network Rule.
sysOptionGet Invoke this method to get one or more application options and their associated values.
sysOptionGetDescription Invoke this method to get the text description for the specified system option. This information can be used to provide the user with a description of the option and its purpose.
sysOptionGetList Invoke this method to get one or more system options and their associated values and other extended information including the default value and description.
sysOptionSet Invoke this method to set one or more system options.
sysRightsGetMeta This operation gets the system rights meta data.
testDatabasePoolConnection This operation tests the database connection.
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.
userApiKeyAdd Invoke this operation to add an API key to the specified account.
userApiKeyDelete Invoke this operation to add an API key to the specified account.
userApiKeyGet Invoke this operation to get one or more API keys.
userApiKeyUpdate Invoke this operation to add an API key to the specified account.
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.
userDeviceDelete Invoke this operation to remove a device registration from the specified account.
userDeviceGetInfo Invoke this operation to get information about one or more devices registered to the specified account.
userDeviceUpdate Invoke this operation to update the specified device associated with this account.
userGetAvailability Invoke this to obtain the availability status for the specified user.
userGetAvailabilityList Invoke this to get a list of possible user availability status values.
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.
userGetRoleList Invoke this operation to get a list of roles assigned to the specified user.
userProfileGetList Invoke this operation to get a list of user profiles
userProfileSet Invoke this method to update user profile data
userRecoverPassword Resets the password for the specified user.
userRemoveRole Invoke this operation to remove one or more role assignments from the specified user.
userSetAccountStatus This operation sets the account status of the specified user.
userSetAvailability Invoke this operation to change the availability status for the specified user.
userSetGroupOptions Invoke this operation to set the options for the specified group membership.
userTemplateCreate Invoke this method to create a user template.
userTemplateDelete Invoke this method to delete a user template.
userTemplateGet Invoke this method to get user template details.
userTemplateList Invoke this method to get a list of user templates.
userTemplateUpdate Invoke this method to update a user template.
userUpdate Invoke this method to update one or more user properties.
webhookCreate This operation creates a new web hook. For more information see the operation admin:webhookGetInfo.
webhookDelete This operation deletes a specified web hook.
webhookEnable This operation deletes a web hook.
webhookGetEventSourceList This operation gets a list of webhook events available
webhookGetInfo This operation gets information about a web hook.
webhookGetList This operation gets a list of web hooks defined on the system.
webhookUpdate This operation updates an existing web hook. For more information see the operation admin:webhookGetInfo.

Powered by Hornbill, for more information click here. (page served by Esp.hornbill.ServerService, 8.0.0.2865.)