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