315 lines
8.8 KiB
HTML
315 lines
8.8 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>Set Encrypted User Password (QSYSUPWD) 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Set Encrypted User Password (QSYSUPWD) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<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 from QSYRUPWD</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Format</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Set Encrypted User Password (QSYSUPWD) API sets the encrypted password
|
||
|
|
data for the specified user profile by using the receiver variable that was
|
||
|
|
retrieved with the Retrieve Encrypted User Password (QSYRUPWD) API.</p>
|
||
|
|
|
||
|
|
<p>The QSYSUPWD API changes the
|
||
|
|
following fields in addition to the password values:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The password expiration field is set to *NO.</li>
|
||
|
|
|
||
|
|
<li>The password change date field is updated.</li>
|
||
|
|
|
||
|
|
<li>The user profile change date is updated.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> If an error occurs while attempting to set the
|
||
|
|
iSeries Support for Windows Network Neighborhood (iSeries NetServer)
|
||
|
|
password, the CPF22F0 error is returned
|
||
|
|
and no other encrypted password data is set.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>If the local password management (LCLPWDMGT) value
|
||
|
|
for the specified user profile is *NO, then the local i5/OS password will be set to *NONE. Also, if
|
||
|
|
the LCLPWDMGT value was *NO for the user profile on the system where the QSYRUPWD API was called,
|
||
|
|
then the local i5/OS password will be set to *NONE.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>The QSYRUPWD (Retrieve Encrypted User Password) API does not retrieve
|
||
|
|
product-level encrypted data that may be associated with a user profile.
|
||
|
|
Additional steps may be needed after the QSYSUPWD (Set Encrypted
|
||
|
|
User Password) API is run, to ensure that product-level encrypted data is
|
||
|
|
correct.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>User Profile Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*ALLOBJ and *SECADM</dd>
|
||
|
|
|
||
|
|
<dt><em>API Public Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXCLUDE</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Receiver variable from QSYRUPWD</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The variable that is used to set the encrypted password for the user. The
|
||
|
|
receiver variable from the QSYRUPWD API must be used as input to this API. For
|
||
|
|
this API to successfully set the encrypted password for the user, the bytes
|
||
|
|
returned value must be equal to the bytes available value in the input data.
|
||
|
|
The input data must be retrieved from the receiver variable used by the
|
||
|
|
QSYRUPWD API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The name of the format that is used to set the user's encrypted password
|
||
|
|
data.</p>
|
||
|
|
|
||
|
|
<p>The following values are allowed:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="30 70" -->
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em><a href="#upwd0100">UPWD0100</a></em></td>
|
||
|
|
<td valign="top">Encrypted password will be set</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</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><a name="upwd0100">UPWD0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p>The following table describes the input variable that is to be passed as the
|
||
|
|
first parameter to QSYSUPWD. This input variable must be the same data as the
|
||
|
|
receiver variable that is returned by the QSYRUPWD API. The receiver variable,
|
||
|
|
returned by the QSYRUPWD API, cannot be changed in any way prior to passing the
|
||
|
|
data as input to the QSYSUPWD API. If this data is changed, the QSYSUPWD API
|
||
|
|
will not be able to successfully change the password for the user. For detailed
|
||
|
|
descriptions of the fields in the tables, see <a href="#HDRSYSUFD">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</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</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(10)</td>
|
||
|
|
<td align="left" valign="top">User profile name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Encrypted user password data</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSYSUFD">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available when
|
||
|
|
retrieved by the QSYRUPWD API. For the QSYSUPWD API to successfully set the
|
||
|
|
encrypted password for the user, this value must be equal to the bytes returned
|
||
|
|
value. If the bytes available field is greater than the bytes returned field,
|
||
|
|
this input cannot be used to successfully set the encrypted password for the
|
||
|
|
user.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data.</p>
|
||
|
|
|
||
|
|
<p><strong>Encrypted user password data.</strong> The encrypted password data
|
||
|
|
for the user profile.</p>
|
||
|
|
|
||
|
|
<p><strong>User profile name.</strong> The name of the user profile for which
|
||
|
|
the password will be changed.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" 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">CPD2201 E</td>
|
||
|
|
<td width="85%" valign="top">System user profile cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2203 E</td>
|
||
|
|
<td valign="top">User profile &1 not correct.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2225 E</td>
|
||
|
|
<td valign="top">Not able to allocate internal system object.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF222E E</td>
|
||
|
|
<td valign="top">&1 special authority is required.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF22F0 E</td>
|
||
|
|
<td align="left" valign="top">Unexpected errors occurred during processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C21 E</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF4AB2 E</td>
|
||
|
|
<td valign="top">Receiver variable from QSYRUPWD has been altered.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9801 E</td>
|
||
|
|
<td valign="top">Object &2 in library &3 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V3R7
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|