Skip to main content

system.kanoa.security.getUsers(paramsDict)

Returns users filtered by the passed parameters. paramsDict keys are optional.


Parameters

paramsDict Dictionary

- assetIdintId of asset to check functionName against. Only required when functionName is passed
- functionNameStringWhen passed with assetId, filters to users who have this function on that asset (or an ancestor of it), plus all gateway admins
- idpUserIdIntegeruserId coming from the ignition authentication session properties
- userIdInteger
- userNameString

Returns

userData pyDataset


Example

userData = system.kanoa.security.getUsers({'userName': 'johndoe'})