User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

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.


Caution_friendly

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. 


Editor_notes

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. 

Panel
titleSyntax

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]

New_in
FunctionMargintrue
Version8.1.8



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


Panel
titleCode Examples

There are no code examples for this function.

Panel
titleKeywords

system perspective logout, perspective.logout