Service Info: session


Service Description

This service provides the operations needed to establish a new session, close an existing session, obtain session information and other session related actions.

Available Operations

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

Operation Description
changePassword Invoke this operation to change the login password for the account that relates to the current session. This operation is used by the user to change his/her password interactively.
checkRights Invoke this operation to test if your session has the specified rights.
cloneSession Invoke this operation to establish a new session that is a clone of your existing session. Cloned sessions are typically use to allow asynchronous operations to complete their task even if the initiating session is closed. The application context, session variables, and session temporary data will be cloned along with the new session. So operations using the cloned sessions will assume the session state at the point the session was cloned.

Cloned sessions do not use a license from the systems concurrent license pool. However, the license allocated to a session through the logon operation will only be released when all cloned sessions have been closed.
deviceAdd Add a device to your user account, ready for device registration.
deviceDelete Invoke this operation to delete a registered device from your account.
deviceDeregister Invoke this operation to deregister a device from your account.
deviceGetInfo Invoke this operation to get information about one or more device associations to your account.
deviceRegister Called from a device to register its self. The account holder must have already added the device and generated an auth code
deviceUpdate Invoke this operation to update the associated device association.
getApplicationCacheStates Invoke this operation to get a list of the applications and the current cache states. Only applications that are available to your profile are returned.
getApplicationList Invoke this operation to get a list of the applications that are available to your profile. This is different to the admin::getApplicationList method which returns a list of all ESP applications that are installed on the server.
getApplicationOption Invoke this method to get one or more application options and their associated values. This operation returns user-specific values set by the user associated with the current session. If the session is an anonymous guest, then only application options that start 'guest.anonymous.*' can be returned. If the session is an authenticated guest then only application options that start 'guest.*' can be returned.
getApplicationStrings Invoke this method to get one or more application strings for the specified/current language. Applications can be easily internationalized by using this application settings scheme. See the file "com.hornbill.core/app-strings.xml" and "welcome/app-strings.xml" for examples and more details. If the session is an anonymous guest, then only application options that start 'guest.anonymous.*' can be returned. If the session is an authenticated guest then only application options that start 'guest.*' can be returned.
getAvailabilityStatus Invoke this operation to get your own or other user's availability status.
getMessageNotificationHistory This operation returns message notification history items in a descending order of the latest message first.
getMessageNotificationHistoryCount This operation returns count of message notification history items corresponding to the specified filtering criteria.
getSSOProfiles Gets a list of SSO profile configurations defined on this instance. Only enabled profiles are returned. Information returned here is safely consumable for non-authenticated users of the system
getSessionInfo Returns information about your current session, or, with appropriate rights any other active session on the server.
getSystemLicenseInfo Invoke this operation to obtain information about the server license and version information.
guestAuthenticateSAML Used to establish a session for a guest based on a single sign-on SAML 2.0 authentication response. In order to invoke this you must have previously made a call to 'session::guestGetSessionInfo' to establish an anonymous guest session.
guestChangePassword Invoke this operation to change the password for the guest account that relates to the current session. This operation is used by the guest user to change his/her password.
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.
guestLogoff Invoke this operation to log off a guest user.
guestLogon Invoke this operation to log in as a guest to the system. In order to invoke this you must have previously made a call to 'session::guestGetSessionInfo'. This operation will verify you as a valid contact on the system. If you are authorised to log in then your session will be promoted to an 'authenticated' visitor. If you are already logged in as a full user, this operation will fail.
guestPasswordResetCancel Invoke this operation to cancel a request from the session::guestPasswordResetRequest challenge.
guestPasswordResetRequest Invoke this operation to request a "Self Service Password Reset" on the specified guest account. This will return a challenge key which must be used to invoke the session::guestPasswordResetResponse operation. The challenge key is only valid for a period of time set by the portal's security policy settings
guestPasswordResetResponse Invoke this operation to provide a response to the session::guestPasswordResetRequest challenge. You may need to call this operation multiple times for a single password request depending on the security policy set on the portal.
guestRegister Invoke this operation when an anonymous guest wishes to register themselves on the system. The portal account must allow self-registration for this operation to succeed.
guestSessionClose Invoke this operation to close down the guest session.
isSessionValid Invoke this operation to find if the session is valid or not.
keepAlive This operation is used, generally by other services to 'touch' the bound session. Invoking this will cause a session recovery to occur which will reset the last activity time. You can optionally specify one or more other session's to keep alive.
locationGetCurrent Invoke this method to get your current location.
locationRegisterCurrent Invoke this method to register your current location. The system will track the last location registered for each user account.
setApplicationOption Invoke this method to set one or more application options. Options set here are applied to the current user only. Only options marked as user editable can be set by this operation
setAvailabilityStatus Invoke this operation to change your availability status.
setCurrentLanguage Invoke this operation to set the sessions current language context.
setDiagnosticsLevel Invoke this operation to set the diagnostics level that should be reported back for your session. Once you have called this, diagnostic reporting will begin with the operation next invoked by your session. The diagnostics level will remain set for the life of the session unless you make further calls to this operation. You can check the status of the diagnostic level in use by looking at the values returned by the session::getSessionInfo operation.
setMessageNotificationStatus This operation sets the status of one or more notification messages
setVariable Invoke this operation to set or clear one or more session variables.
userAuthenticateSAML Used to establish a session for a user based on a single sign-on SAML 2.0 authentication response.
userLogoff Invoke this operation to shutdown an user session. Once shutdown, any license allocation will be returned to the concurrent license pool.
userLogon Invoke this operation to establish a user session. Once established this session will use a license from the systems concurrent license pool.
userPasswordResetCancel Invoke this operation to cancel a request from the session::userPasswordResetRequest challenge.
userPasswordResetRequest Invoke this operation to request a "User Password Reset" on the specified user account. This will return generate a challenge key and invoke the global Flowcode event handler OnPasswordResetRequest which in turn will initiate the request to the user for confirmation. The challenge key is only valid for a period of time set by the systems security policy settings.
userPasswordResetResponse Invoke this operation to provide a response to the session::userPasswordResetRequest challenge. You may need to call this operation multiple times for a single password request request depending on the security policy set for the system and account.
userProfileGet Invoke this method to get user profile data
userProfileGetList Invoke this operation to get a list of user profiles
userProfileSet Invoke this method to update your user profile data. It cannot be used to update any other user's profile
userProfileVisibilityGet Get profile visibility info
userProfileVisibilitySet Sets the visibility of one or more sections for your profile.

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