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

250 lines
6.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>Remove Profile Tokens (QSYRMVPT) 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>Remove Profile Tokens (QSYRMVPT) API</h2>
<div class="box" style="width: 60%;">
<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%">Remove option</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</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;Optional Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="50%">Profile token</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(32)</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 Remove Profile Tokens (QSYRMVPT) API removes all profile tokens, removes
all profile tokens for a specific user profile, or removes a specific profile
token. When a profile token is removed, it is no longer valid for use with
other profile token APIs.</p>
<p>This API can be used to remove all profile tokens on the system. This may be
useful if the maximum number of profile tokens have been generated for the
system (message CPF4AAA was sent or a PS-M security audit entry was sent). The
most likely reason for this to happen is that someone is attempting to lock up
parts of the system by generating multitudes of profile tokens. This API
provides an alternative to restarting the system. After calling this API, the
administrator may want to analyze the audit log to determine who is attempting
to lock up the system.</p>
<p>This API can be used to remove all profile tokens that have been generated
for a user profile. You may want to remove all profile tokens for a user
profile if security information has changed for the user profile (for example,
the password or group list).</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Authority, if *ALL is specified</em></dt>
<dd>*ALLOBJ and *SECADM</dd>
<dt><em>Authority, if specific user is specified</em></dt>
<dd>*SECADM</dd>
<dt><em>User profile authority, if specific user is specified</em></dt>
<dd>*OBJMGT and *USE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Remove option</strong></dt>
<dd>INPUT; CHAR(10)
<p>Whether all profile tokens are being removed, all profile tokens for a given
user are being removed, or a specific profile token is being removed.</p>
<p>One of the following values may be specified:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All profile tokens will be removed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRFTKN</em></td>
<td align="left" valign="top">The specified profile token will be removed. If
this value is specified, the optional parameter that contains the profile token
must be specified.</td>
</tr>
<tr>
<td align="left" valign="top"><em>User name</em></td>
<td align="left" valign="top">The name of the user profile for which to remove
all profile tokens.</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>Optional Parameter Group</h3>
<dl>
<dt><strong>Profile token</strong></dt>
<dd>INPUT; CHAR(32)</dd>
</dl>
<p>The profile token to be removed. This parameter is required only if *PRFTKN
is specified in the Remove option parameter. If the Remove option is not
*PRFTKN and this parameter is specified, then this parameter must contain
*NONE.</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">CPF2204 E</td>
<td width="85%" valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF222E E</td>
<td align="left" valign="top">&amp;1 special authority is required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2217 E</td>
<td align="left" valign="top">Not authorized to user profile &amp;1.</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">CPF2274 E</td>
<td align="left" valign="top">Profile token is not valid.</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">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 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">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: V4R4
<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>