The Liquit.Logout function is only available for Application Workspace Server 3.1 and later.
The Logout function allows you to disconnect from the Application Workspace and the provided identity source. It is possible to select whether or not only the Application Workspace session should be terminated.
Request parameters
The following parameters are available for the API:
| Name | Description | Default value |
|---|---|---|
| excludeAction | When this parameter is set to false Application Workspace will sign out the user from the Application Workspace as well as the current identity source. | true |
| popUp | Controls whether or not a popup will be triggered to logout the user. If the value is set to false, an iframe will be used to trigger the logout. This parameter is available only for Application Workspace Server 3.3 and later. | true |
| feedback | Feedback returns false when the logout action is in progress. When the logout action is completed, feedback returns true. This parameter is available only for Application Workspace Server 3.3 and later. |
Example
Liquit.Logout({
// If excludeAction is set to false, the logout function will also log you out from the selected identity source. The default value is true.
excludeAction: false,
// If popUp is set to true, a popup window will be used to execute the logout action. If set to false, an iframe will be used.
popUp:true
}, function (feedback) {
// The feedback parameter is only available for Application Workspace Server 3.3 and later
if (feedback == false) {
console.log('Logout in progress')
}
if (feedback == true) {
console.log('Logout executed.')
}
});