Triggers a logout event, which will log the user out. For this function to work, an Identity Provider (IdP) must be set in the Perspective Project properties.


Be advised that this function should not be used in the same script, or in the same triggering event as  system.perspective.login . Logging in and Logging out should always triggered by separate events. 


Hiding this. See the note on the system.perspective.login page for context. 

The recommend approach to logging out a user, and then quickly logging in as different user, is to set the forceAuth  parameter to "True" on the system.perspective.login function. 

system.perspective.logout([sessionId], [pageId])

  • Parameters

String sessionId - Identifier of the Session to target. If omitted, the current Session will be used automatically. When targeting a different Session, then the pageId parameter must be included in the call. [optional]

String pageId - Identifier of the Page to target. If omitted, the current Page will be used automatically. [optional]



String message - The message to display when the user logs out of their session. This message is only shown when the project requires authentication. If omitted, the default message (set in Project Properties) is shown. [Optional]

  • Returns

Nothing

  • Scope

Gateway, Perspective Session


There are no code examples for this function.

system perspective logout, perspective.logout