Versions Compared

Old Version 18

changes.mady.by.user Paul Scott

Saved on

compared with

New Version Current

changes.mady.by.user Paul Scott

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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.


Note that calling this function after a user is already logged in will not

lot

log out the previous user. 

Note

Be advised that this function should not be used in the same script, or in the same triggering event as system.perspective.logout. Logging in and Logging out should always triggered by separate events altogether. 

Editor_notes

Removed the "recommended" approach, since it doesn't seem to address the actual use case. Waiting to hear back from dev before we add something back. 

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.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 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
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