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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits


Scripting_function



Panel
titleDescription

Triggers a login event that will allow the user to login with the project's configured Identity Provider (IdP). For this function to work, an Identity Provider must be set in Perspective project properties. This is particularly useful when you want it to be possible to start a session without authentication and sign in to access certain restricted features.


Panel
titleSyntax

system.perspective.login([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


Editor_notes

on 8.0.14 release, replace the panel above with the panel below:


Panel
titleSyntax

system.perspective.login([sessionId], [pageId], [forceAuth])

  • 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]

Boolean forceAuth- Determines if Ignition should ask the Identity Provider to re-authenticate the user, even if the user is already signed into the Identity Provider. If set to true, then the Identity Provider will ask the user to re-enter their credentials. If set to false, then the gateway Gateway will request that the Identity Provider use the last provided credentials for the session, potentially allowing re-authentication without requiring the user to re-type their credentials. Note that support for this argument is determined by the Identity Provider; the IdP may choose to ignore this request. If this parameter is omitted, then the function will use the re-authentication setting defined under Project Properties. [optional]

  • Returns

None

  • Scope

Perspective Session




Panel
titleCode Examples

There are no examples associated with this function

Editor_notes

On 8.0.14 release, make the example below publicly viewable. 

Code Block
languagepy
titleForce Authentication
# When forceAuth is True, the user will always be required to type in their credentials, even if they're already logged in. 
system.perspective.login(forceAuth=True)





Panel
titleKeywords

system perspective login, perspective.login