Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata

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. 

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. 

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