Security Manager Module
| Description: | Examines the rules that apply to the current user or the named user to determine if the specified privilege has been granted. |
| Returns: | Boolean |
Usage:  |
Script or steady state. |
| Related to: | GetAccountID | GetAccountInfo | GetFullName | GetGroupName | GetUserName | IsLoggedOn | IsSuspended | UIErrorToText |
| Format: |
\SecurityManager\SecurityCheck(Privilege [, Suppress, AccountName, DenyCaller, TagName]) |
| Parameters: |
| Privilege |
|
Required. A privilege number to be used in the security check. |
| Suppress |
| Optional. A Boolean indicating whether a privilege refusal dialog should be displayed if the SecurityCheck fails. TRUE to suppress the dialog. Defaults to FALSE. |
| AccountName |
| Optional. The name or AccountID of an account against which to check the privilege. Defaults to the caller’s account. |
| DenyCaller |
| Optional. The object value of the caller to use when launching the privilege refusal dialog. Defaults to the caller’s user session. This is used to control the lifetime of the dialog until dismissed by user action. |
| TagName |
| Optional. The name of a tag that will be used in the security check. |
| Comments: | This module can be called in script or in steady-state. It returns TRUE if the security check passes and FALSE otherwise. In steady-state the return value may change if the parameters change, if the user's signed in state changes, or if there is a configuration change on the user’s account. The security check is iteratively done against each rule in the user account until either a matching rule is found or all rules have been checked and no match found. If the TagName parameter is Invalid or not specified, SecurityCheck looks in the caller’s scope for the nearest tag and uses the name of that tag as the TagName parameter. |
