ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QSYCUSRS.htm

375 lines
9.9 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Check User Special Authorities (QSYCUSRS) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Dec 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Check User Special Authorities (QSYCUSRS) API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Authority indicator</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">User profile name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Special authority</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Number of authorities</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Call level</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Check User Special Authorities (QSYCUSRS) API provides an indication of
whether the user has the specified special authorities.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Profile Authority</em></dt>
<dd>*READ</dd>
</dl>
<p>When the API checks for special authorities and the user profile name
parameter is *CURRENT or the user who is currently running, the special
authorities available to the user include any special authorities the user or
the group has, and any program adopted special authorities. If the user profile
specified is not the user currently running, then the special authorities
available to the user are only the special authorities the user and his group
have.</p>
<p>If previous programs in the program stack adopt their owner's authority, the
adopted authority for the current program is the accumulated adopted authority
from all other programs in the program stack that adopt authority.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Authority indicator</strong></dt>
<dd>OUTPUT; CHAR(1)
<p>Whether the user has the specified special authorities.</p>
<p>This parameter contains one of the following:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td align="left" valign="top">The user has the specified special
authorities.</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td align="left" valign="top">The user does not have the specified special
authorities.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>User profile name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the user whose special authorities are checked.</p>
<p>You can specify the following special value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">The special authorities for the user currently
running are checked.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Special authority</strong></dt>
<dd>INPUT; CHAR(*)
<p>The special authorities checked for the user. This parameter can contain up
to eight 10-character fields.<br>
Each of the 10-character fields can contain one of the following special
values.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALLOBJ</em></td>
<td align="left" valign="top">All object special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*AUDIT</em></td>
<td align="left" valign="top">Audit special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IOSYSCFG</em></td>
<td align="left" valign="top">Input/output system configuration special
authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JOBCTL</em></td>
<td align="left" valign="top">Job control special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAVSYS</em></td>
<td align="left" valign="top">Save system special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SECADM</em></td>
<td align="left" valign="top">Security administrator special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SERVICE</em></td>
<td align="left" valign="top">Service special authority.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SPLCTL</em></td>
<td align="left" valign="top">Spool control special authority.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Number of authorities</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of special authorities specified in the special authority
parameter. You can specify 1 through 8.</p>
</dd>
<dt><strong>Call level</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of call levels to back up in the program stack to do the
authority check. For example, if the program that calls this API adopts
authority, you would probably not want the authority check to use the adopted
authority. Therefore, the authority check should be done at the call level
previous to the current level. This parameter should then contain a 1. You can
check the authority at the various call levels by signifying a numeric
equivalent to the call level. For example, to check the authority at the
current call level, specify a 0; to check the authority at the previous call
level, specify a 1.</p>
<p>This parameter is only used if the user profile name parameter is *CURRENT,
or the current user name for the job.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF22F7 E</td>
<td width="85%" valign="top">Number of authorities must be between 1 and
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22F8 E</td>
<td align="left" valign="top">Special authority value &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22F9 E</td>
<td align="left" valign="top">Call level &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2203 E</td>
<td align="left" valign="top">User profile &amp;1 not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2225 E</td>
<td align="left" valign="top">Not able to allocate internal system object.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8122 E</td>
<td align="left" valign="top">&amp;8 damage on library &amp;4.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td align="left" valign="top">One or more libraries in library list
deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>