You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

This function is used in Python Scripting.

Description

Triggers a logout event, which will log the user out. For this function to work, an Identity Provider 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 altogether. 

Syntax

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]

  • Returns

None

  • Scope

Perspective Session


Code Examples

There are no examples associated with this scripting function.

Keywords

system perspective logout, perspective.logout

  • No labels