View source for $UsrPriv

<p>
The <var>$UsrPriv</var> function is used to test whether a user ID has been granted specific <var class="product">Model&nbsp;204</var> privileges. </p>

==Syntax==
<p>
The format of the <var>$UsrPriv</var> function is:</p>
<p class="syntax">$UsrPriv(<span class="term">privilege</span>, <span class="term">logging-option</span>) 
</p>
<p>
Where:</p>
<ul>
<li><var class="term">privilege</var> is the privilege that is to be validated. Privilege can be one of the following values:
<ul>
<li>ANY_ADMINISTRATOR
<p>
The ANY_ADMINISTRATOR privilege test verifies that the user is User 0 or a system manager.</p></li>

<li>CHANGE_FILE_PASSWORD</li>

<li>CHANGE_LOGIN_PASSWORD </li>

<li>OVERRIDE_RECORD_SECURITY</li>

<li>SUPER_USER</li>

<li>SYSTEM_ADMINISTRATOR</li>

<li>SYSTEM_MANAGER</li>
</ul></li>

<li><var class="term">logging-option</var> specifies whether <var class="product">Model&nbsp;204</var> should indicate that an error message should be issued for security violations:
<ul>
<li>LOG indicates that any privilege violation is logged.</li>

<li>NOLOG indicates that the privileges should be determined but any violation found is not logged. </li>
</ul>
<p>
Currently, the logging option affects only the Security Server (formerly RACF) or Top Secret interface. The option has no effect on <var class="product">Model&nbsp;204</var>; the ACF2 Interface always logs a security violation regardless of the logging option.</p>
<p>LOG is the default if a logging option is not specified. </p>
</li>
</ul>
<p><var>$UsrPriv</var> returns a numeric true/false value indicating the result of the authorization check, as follows: </p>

<table>
<tr class="head">
<th>Value</th>
<th>User is...</th></tr>

<tr><td>0</td>
<td>Not authorized for the privilege or an unknown privilege name is specified.</td></tr>

<tr><td>1</td>
<td>Authorized for the specified privilege. </td></tr>
</table>

==Example==
<p>
The following statement could be used to test if the current user ID is authorized as a system manager.</p>
<p class="code">IF $USRPRIV('SYSTEM_MANAGER','NOLOG') THEN
    .
    .
    .
<b></b>* PERFORM SYSTEM MANAGER AUTHORIZED CODE
END IF
<b></b>* ELSE UNAUTHORIZED FOR SYSTEM MANAGER FUNCTIONS   
</p>

==$UsrPriv and application subsystems==
<p>
Generally speaking, <var>$UsrPriv</var> will return a value based upon the user's privileges. However, if <var>$UsrPriv</var> is called from within [[Application Subsystem development|application subsystem (APSY)]] code, then subsystem privileges may override standard user privileges, as follows:</p>
<ul>
<li>If APSY privileges have been set, <var>$UsrPriv</var> returns a value based upon the subsystem privileges rather than the user's privileges.</li>

<li>If start login privileges have been set for the subsystem, and <var>$UsrPriv</var> is called from within the subsystem initialization procedure, <var>$UsrPriv</var> returns a value based upon the start login privileges.</li>

<li>If the user's sclass has privileges set, they override standard subsystem privileges for the user, and <var>$UsrPriv</var> returns a value based upon the sclass privileges.</li>
</ul> 

[[Category:SOUL $functions]]