Security Functions
Overview
These functions check user permissions as part of the rule notification logic and allow or deny response actions such as sending portals or invoking scripts.
Reference
Processing
The boolean functions below return true if the user is valid and allowed to execute the given action. Otherwise, the function returns false.
As an alternative to if/else syntax, set the optional err parameter to true, which causes the function to raise error and stop processing altogether in case of insufficient permissions.
userInGroup
userInGroup(string user, string group [, bool err]) bool
Returns true if the user exists, is enabled, and belongs to the specified user group.
userHasRole
userHasRole(string user, string role [, bool err]) bool
Returns true if the user exists, is enabled, and has the specified role.
userAllowEntity
userAllowEntity(string user, string entity [, bool err]) bool
Returns true if the user exists, is enabled, and has READ permission for the specified entity.
userAllowEntityGroup
userAllowEntityGroup(string user, string entityGroup [, bool err]) bool
Returns true if the user exists, is enabled, and has READ permission to the specified entityGroup.
userAllowPortal
userAllowPortal(string user, string portal [, bool err]) bool
Returns true if the user user exists, is enabled, and has permissions to view the specified portal.