1064 lines
29 KiB
HTML
1064 lines
29 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>Retrieve Users Authorized to an Object (QSYRTVUA) 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 -->
|
|
<!-- Edited by Kersten Jan 02 -->
|
|
<!--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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Retrieve Users Authorized to an Object (QSYRTVUA) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
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%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Returned records feedback information</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Length of returned records feedback
|
|
information</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">Format name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Object name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Length of object name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</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>
|
|
|
|
Optional Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">9</td>
|
|
<td align="left" valign="top" width="50%">Symbolic link</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve Users Authorized to an Object (QSYRTVUA) API provides
|
|
information about the users who are authorized to an object. The API returns
|
|
the following information:</p>
|
|
|
|
<ul>
|
|
<li>A list of users who have a private authority to the object and the
|
|
authority that the users have</li>
|
|
|
|
<li>The public authority for the object</li>
|
|
|
|
<li>Other authority information for the object, such as the name of the owner,
|
|
the primary group, and the authorization list securing the object</li>
|
|
|
|
<li>For objects in the QDLS file system, the sensitivity level of the
|
|
object</li>
|
|
</ul>
|
|
|
|
<p>This API provides information that is similar to the Display Authority
|
|
(DSPAUT) command.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>*X is required for all directories in the path.</p>
|
|
|
|
<dl>
|
|
<dt><em>Authority to Object</em></dt>
|
|
|
|
<dd>*OBJMGT</dd>
|
|
|
|
<dt><em>Authority to Object (QSYS.LIB *AUTL object)</em></dt>
|
|
|
|
<dd>No authority is required</dd>
|
|
|
|
<dt><em>Authority to Object (QDLS file system)</em></dt>
|
|
|
|
<dd>*ALL</dd>
|
|
|
|
<dt><em>Authority to Object (QOPT file system)</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that receives the information requested. You can
|
|
specify the size of the area to be smaller than the format requested as long as
|
|
you specify the length parameter correctly. As a result, the API returns only
|
|
the data that the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable provided. The length of receiver
|
|
variable parameter may be specified up to the size of the receiver variable
|
|
that is specified in the user program. If the length of receiver variable
|
|
parameter that is specified is larger than the allocated size of the receiver
|
|
variable that is specified in the user program, the results are not
|
|
predictable.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Returned records feedback information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>Information about the object and information about the entries that are
|
|
returned in the receiver variable.</p>
|
|
|
|
<p>See <a href="#HDRRFDBK">Format of Returned Records Feedback Information</a>
|
|
for details.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of returned records feedback information</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the returned records feedback information provided. The length
|
|
of the returned records feedback information parameter may be specified up to
|
|
the size of the returned records feedback information variable specified in the
|
|
user program. If the length of the returned records feedback information
|
|
parameter specified is larger than the allocated size of the returned records
|
|
feedback information variable that is specified in the user program, the
|
|
results are not predictable. The minimum length is 16 bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The name of the format that is used to return information about the users
|
|
who are authorized to the object.</p>
|
|
|
|
<p>You can specify this format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="30 70" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRSYRTVU2">RTUA0100</a></em></td>
|
|
<td align="left" valign="top">Each entry contains the name of the profile that
|
|
is authorized to the object, whether the profile is a user profile or a group
|
|
profile, and the profile's authority to the object.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Object name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The object name.</p>
|
|
<p>If the length of the
|
|
object name is greater than 0,
|
|
then this parameter is assumed to be a path name represented in the coded
|
|
character set identifier (CCSID) currently in effect for the job. If the
|
|
CCSID of the job is 65535, this parameter is assumed to be
|
|
represented in the default CCSID of the job.</p>
|
|
<p>If the length of the object name is -1, then this parameter is assumed to
|
|
be a Qlg_Path_Name_T structure that contains a path name
|
|
or a pointer to a path name. For more information on the Qlg_Path_Name_T
|
|
structure, see <a href="../apiref/pns.htm">Path name format</a>.
|
|
</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of object name</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the object name.
|
|
If the length is -1, the
|
|
object name parameter is assumed to be a Qlg_Path_Name_T structure.
|
|
</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>Optional Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Symbolic link</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>If the last component in the path name is a symbolic link,
|
|
specifies whether or not to retrieve users authorized to the
|
|
symbolic link or users authorized to the object pointed to by
|
|
the symbolic link.
|
|
</p>
|
|
|
|
<p>The valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><strong>*NO</strong></td>
|
|
<td valign="top">The users authorized to the symbolic link object are
|
|
not retrieved. The users authorized to the object pointed to by the
|
|
symbolic link are retrieved.
|
|
<p>This is the default value when the Symbolic link parameter is
|
|
not specified</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*YES</em></td>
|
|
<td valign="top">If the object is a symbolic link,
|
|
the users authorized to the symbolic link object are retrieved.
|
|
The users authorized to the object pointed to by the symbolic link
|
|
are not retrieved.
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRSYRTVU1">Receiver Variable Description</a></h3>
|
|
|
|
<p>The following table describes the order and format of the data that is
|
|
returned in the receiver variable for each user that is authorized to the
|
|
object. For detailed descriptions of the fields in the table, see <a href=
|
|
"#HDRSYRTVU5">Field Descriptions</a>.</p>
|
|
|
|
<h4><a name="HDRSYRTVU2">RTUA0100 Format</a></h4>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Profile name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">0A</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">User or group indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="center" valign="top">0B</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Data authority</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">21</td>
|
|
<td align="center" valign="top">15</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Authorization list management</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Object management</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">23</td>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Object existence</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Object alter</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="center" valign="top">19</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Object reference</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="center" valign="top">1A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Object operational</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">37</td>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Data read</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="center" valign="top">26</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Data add</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">39</td>
|
|
<td align="center" valign="top">27</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Data update</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Data delete</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="center" valign="top">29</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Data execute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">42</td>
|
|
<td align="center" valign="top">2A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRRFDBK">Format of Returned Records Feedback Information</a></h3>
|
|
|
|
<p>For a description of the fields in this format, see <a href=
|
|
"#HDRSYRTVU5">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Bytes returned in the returned
|
|
records feedback information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available in the returned records feedback
|
|
information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes returned in the receiver variable</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available in the receiver variable</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of authorized users</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for each authorized user
|
|
returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Owner</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Primary group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Authorization list</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Sensitivity level</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="HDRSYRTVU5">Field Descriptions</a></h4>
|
|
|
|
<p><strong>Authorization list.</strong> The name of the authorization list that
|
|
is securing the object. If there is no authorization list that secures the
|
|
object, this field is *NONE.</p>
|
|
|
|
<p><strong>Authorization list management.</strong> Whether the user has this
|
|
authority to the object. This field is only valid if the object is an
|
|
authorization list.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Bytes available in the receiver variable.</strong> The number of
|
|
bytes of data that is available to be returned to the user in the receiver
|
|
variable. All available data is returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes available in the returned records feedback
|
|
information.</strong> The number of bytes of data available to be returned to
|
|
the user in the returned records feedback information. All available data is
|
|
returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes returned in the receiver variable.</strong> The number of
|
|
bytes of data that is returned to the user in the receiver variable.</p>
|
|
|
|
<p><strong>Bytes returned in the returned records feedback
|
|
information.</strong> The number of bytes of data returned to the user in the
|
|
returned records feedback information.</p>
|
|
|
|
<p><strong>Data add.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data authority.</strong> The data authority that the authorized user
|
|
has to the object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RWX</em></td>
|
|
<td align="left" valign="top">The user has object operational, read, add,
|
|
update, delete, and execute authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RW</em></td>
|
|
<td align="left" valign="top">The user has object operational, read, add,
|
|
update, and delete authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*RX</em></td>
|
|
<td align="left" valign="top">The user has object operational, read, and
|
|
execute authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*WX</em></td>
|
|
<td align="left" valign="top">The user has object operational, add, update,
|
|
delete, and execute authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*R</em></td>
|
|
<td align="left" valign="top">The user has object operational and read
|
|
authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*W</em></td>
|
|
<td align="left" valign="top">The user has object operational, add, update, and
|
|
delete authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*X</em></td>
|
|
<td align="left" valign="top">The user has object operational and execute
|
|
authorities to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*EXCLUDE</em></td>
|
|
<td align="left" valign="top">The user has no authority to the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*AUTL</em></td>
|
|
<td align="left" valign="top">The public authority to the object comes from the
|
|
public authority on the authorization list that secures the object. This value
|
|
can be returned only if there is an authorization list that secures the object
|
|
and the authorized user is *PUBLIC.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>USER DEF</em></td>
|
|
<td align="left" valign="top">The user has some combination of data rights that
|
|
do not relate to a special value. The API user should check the individual
|
|
authorities for the user to determine what authority the user has to the
|
|
object.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data delete.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data execute.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data read.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Data update.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Entry length for each authorized user returned.</strong> The entry
|
|
length, in bytes, of each entry in the list of users who are authorized to the
|
|
object.</p>
|
|
|
|
<p><strong>Number of authorized users.</strong> The number of complete entries
|
|
in the list of users who are authorized to the object. A value of zero is
|
|
returned if the list is empty.</p>
|
|
|
|
<p><strong>Object alter.</strong> Whether the user has this authority to the
|
|
object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Object existence.</strong> Whether the user has this authority to
|
|
the object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Object management.</strong> Whether the user has this authority to
|
|
the object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Object operational.</strong> Whether the user has this authority to
|
|
the object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Object reference.</strong> Whether the user has this authority to
|
|
the object.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user does not have this authority.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user has this authority.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Owner.</strong> The name of the owner of the object. If the owner
|
|
has no authority, no authorized user entry is returned for the owner.</p>
|
|
|
|
<p>This field can contain the following special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NOUSRPRF</em></td>
|
|
<td align="left" valign="top">The user profile that owns this object does not
|
|
exist on this system.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Primary group.</strong> The name of the primary group for the
|
|
object. If the primary group has no authority, no authorized user entry is
|
|
returned for the primary group.</p>
|
|
|
|
<p>This field can contain the following special value:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">There is no primary group for the object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NOUSRPRF</em></td>
|
|
<td align="left" valign="top">The user profile that is the primary group for
|
|
this object does not exist on this system.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Profile name.</strong> The name of the user profile that is
|
|
authorized to the object.</p>
|
|
|
|
<p>This field can contain the following special values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PUBLIC</em></td>
|
|
<td align="left" valign="top">Public authority (the authority used by users who
|
|
are not privately authorized) to the object. This is the first entry that is
|
|
returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NOUSRPRF</em></td>
|
|
<td align="left" valign="top">The user profile that is authorized to this
|
|
object does not exist on this system.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NTWIRF</em></td>
|
|
<td align="left" valign="top">The NetWare inherited rights filter to the object
|
|
(only valid for the QNetWare file system).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NTWEFF</em></td>
|
|
<td align="left" valign="top">The NetWare effective rights to the object (only
|
|
valid for the QNetWare file system).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Sensitivity level.</strong> The sensitivity level of a QDLS object.
|
|
For all other objects, this field contains 0.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This value does not apply to this object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">(None) The object has no sensitivity
|
|
restrictions.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">(Personal) The object contains information
|
|
intended for the user as an individual.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">(Private) The object contains information that
|
|
should be accessed only by the owner.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">(Confidential) The object contains information
|
|
that should be handled according to company procedures.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User or group indicator.</strong> Whether this user is a user
|
|
profile or a group profile.</p>
|
|
|
|
<p>This field contains one of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">This user is not a user or a group. This value is
|
|
returned for special values such as *PUBLIC.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">This user is a user profile.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">This user is a group profile.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%">
|
|
<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">CPFA0A9 E</td>
|
|
<td width="85%" valign="top">Object not found. Object is &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFA0CE E</td>
|
|
<td width="85%" valign="top"> Error occurred with path name parameter
|
|
specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFA09C E</td>
|
|
<td width="85%" valign="top"> Not authorized to object. Object is
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C1D E</td>
|
|
<td width="85%" valign="top">Length specified in parameter &1 not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C3A E</td>
|
|
<td align="left" valign="top">Value for parameter &2 for API &1
|
|
not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this
|
|
API was not valid.</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">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &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>
|
|
|