system.security
Security Functions
The following functions give you access to interact with the users and roles in the Gateway. These functions require the Vision module, as these functions can only be used with User Sources and their interaction with Vision Clients.
📄️ getRoles
Finds the roles that the currently logged in user has, returns them as a Python tuple of strings.
📄️ getUsername
Returns the currently logged-in username.
📄️ getUserRoles
Fetches the roles for a user from the Gateway.
📄️ isScreenLocked
Returns whether or not the screen is currently locked.
📄️ lockScreen
Used to put a running client in lock-screen mode.
📄️ logout
Logs out of the client for the current user and brings the client to the login screen.
📄️ switchUser
Attempts to switch the current user on the fly.
📄️ unlockScreen
Unlocks the client, if it is currently in lock-screen mode.
📄️ validateUser
Tests credentials (username and password) against an authentication profile.