This function is used in Python Scripting.


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 be triggered by separate events. 


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]

The following feature is new in Ignition version 8.1.8
Click here to check out the other new features

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


  • Scope

Gateway, Perspective Session

Code Examples
Code Snippet
# This example is a script on a Button component and will log the current user out.

system perspective logout, perspective.logout