friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/eimlistuseraccess.htm

702 lines
23 KiB
HTML
Raw Blame History

<!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>eimListUserAccess()--List EIM User Access</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Created by Therese Dalton on 17 July 2001 -->
<!-- Edited by Kersten Jan 02 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script type="text/javascript" language="javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<!-- ============================================================== -->
<!-- -->
<!-- -->
<!-- ============================================================== -->
<h2> eimListUserAccess()--List EIM
User Access</h2>
<!-- ============================================================== -->
<!-- -->
<!-- S Y N T A X / P A R M T A B L E -->
<!-- -->
<!-- ============================================================== -->
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;eim.h&gt;
int eimListUserAccess(EimHandle * <em>eim</em>,
EimAccessUser * <em>accessUser</em>,
unsigned int <em>lengthOfListData</em>,
EimList * <em>listData</em>,
EimRC * <em>eimrc</em>)
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QSYEIM<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<p>The <strong>eimListUserAccess()</strong> function lists the access groups of
which this user is a member.</p>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- A U T H O R I T I E S A N D L O C K S -->
<!-- -->
<!-- ============================================================== -->
<h3>Authorities and Locks</h3>
<dl>
<dt><em>EIM Data</em></dt>
<dd>Access to EIM data is controlled by EIM access groups. LDAP administrators
also have access to EIM data. The access groups whose members have authority to
the EIM data for this API follow:
<ul>
<li>EIM Administrator</li>
</ul>
<p>The list returned contains only the information that the user has authority
to access.</p>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- P A R A M E T E R S -->
<!-- -->
<!-- ============================================================== -->
<h3>Parameters</h3>
<dl><!-- ============================================================== -->
<!-- eim -->
<!-- ============================================================== -->
<dt><strong>eim</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The EIM handle returned by a previous call to eimCreateHandle(). A valid
connection is required for this function.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- accessUser -->
<!-- ============================================================== -->
<dt><strong>accessUser</strong>&nbsp;&nbsp;(Input)</dt>
<dd>A structure that contains the user information for which to retrieve
access. <br><br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top" nowrap><em>EIM_ACCESS_LOCAL_USER</em></td>
<td align="left" valign="top">Indicates a local user name on the system that the API
is run. The local user name will be converted to the appropriate access id for
this system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_ACCESS_KERBEROS</em></td>
<td align="left" valign="top">Indicates a kerberos principal. The kerberos principal
will be converted to the appropriate access id. For example, petejones@therealm
will be converted to ibm-kn=petejones@threalm.</td>
</tr>
</table>
<p>The EimAccessUser structure layout follows:</p>
<pre>
enum EimAccessUserType {
EIM_ACCESS_DN,
EIM_ACCESS_KERBEROS,
EIM_ACCESS_LOCAL_USER
};
typedef struct EimAccessUser
{
union {
char * dn;
char * kerberosPrincipal;
char * localUser;
} user;
enum EimAccessUserType userType;
} EimAccessUser;
</pre>
</dd>
<dd><br>
<!-- ============================================================== -->
<!-- lengthOfListData -->
<!-- ============================================================== -->
</dd>
<dt><strong>lengthOfListData</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The number of bytes provided by the caller for the <em>listData</em>
parameter. The minimum size required is 20 bytes.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- listData -->
<!-- ============================================================== -->
<dt><strong>listData</strong>&nbsp;&nbsp;(Output)</dt>
<dd>A pointer to the EimList structure.
<p>The EimList structure contains information about the returned data. The API
will return as much data as space has been provided. The data returned is a
linked list of EimUserAccess structures. firstEntry is used to get to the first
EimUserAccess structure in the linked list.</p>
<p>EimList structure:</p>
<pre>
typedef struct EimList
{
unsigned int bytesReturned; /* Number of bytes actually returned
by the API. */
unsigned int bytesAvailable; /* Number of bytes of available data
that could have been returned by
the API. */
unsigned int entriesReturned; /* Number of entries actually
returned by the API. */
unsigned int entriesAvailable; /* Number of entries available to be
returned by the API. */
unsigned int firstEntry; /* Displacement to the first linked
list entry. This byte offset is
relative to the start of the
EimList structure. */
} EimList;
</pre>
<!-- ============================================================== -->
<!-- EimUserAccess -->
<!-- ============================================================== -->
<p>EimUserAccess structure:</p>
<pre>
typedef struct EimUserAccess
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure. */
enum EimAccessIndicator eimAdmin;
enum EimAccessIndicator eimRegAdmin;
enum EimAccessIndicator eimIdenAdmin;
enum EimAccessIndicator eimMappingLookup;
EimSubList registries; /* EimRegistryName sublist */
<img src="delta.gif" alt="Start of change">
enum EimAccessIndicator eimCredentialData;
<img src="deltaend.gif" alt="End of change">
} EimUserAccess;
</pre>
<p>The registries EimSubList gives addressability to a linked list of
EimRegistryName structures.</p>
<!-- ============================================================== -->
<!-- EimRegistryName -->
<!-- ============================================================== -->
<p>EimRegistryName structure:</p>
<pre>
typedef struct EimRegistryName
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure. */
EimListData name; /* Name */
} EimRegistryName;
</pre>
<!-- ============================================================== -->
<!-- EimSubList -->
<!-- ============================================================== -->
<p>EimSubList structure:</p>
<pre>
typedef struct EimSubList
{
unsigned int listNum; /* Number of entries in the list */
unsigned int disp; /* Displacement to sublist. This
byte offset is relative to the
start of the parent structure;
that is, the structure containing
this structure. */
} EimSubList;
</pre>
<p>EimListData structure:</p>
<pre>
typedef struct EimListData
{
unsigned int length; /* Length of data */
unsigned int disp; /* Displacement to data. This byte
offset is relative to the start of
the parent structure; that is, the
structure containing this
structure. */
} EimListData;
</pre>
</dd>
<!-- ============================================================== -->
<!-- eimrc -->
<!-- ============================================================== -->
<dt><strong>eimrc</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The structure in which to return error code information. If the return
value is not 0, eimrc is set with additional information. This parameter may be
NULL. For the format of the structure, see <a href="eimrc.htm">EimRC--EIM
Return Code Parameter</a>.<br>
<br>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- R E T U R N V A L U E -->
<!-- -->
<!-- ============================================================== -->
<h3>Return Value</h3>
<p>The return value from the API. Following each return value is the list of
possible values for the <samp>messageCatalogMessageID</samp> field in the
<em>eimrc</em> parameter for that value.</p>
<dl><!-- ============================================================== -->
<!-- 0 -->
<!-- ============================================================== -->
<dt><strong>0</strong></dt>
<dd>Request was successful.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EACCES -->
<!-- ============================================================== -->
<dt><strong>EACCES</strong></dt>
<dd>Access denied. Not enough permissions to access data.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_ACCESS (1)</em></td>
<td align="left" valign="top">Insufficient access to EIM data.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBADDATA -->
<!-- ============================================================== -->
<dt><strong>EBADDATA</strong></dt>
<dd>eimrc is not valid.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBUSY -->
<!-- ============================================================== -->
<dt><strong>EBUSY</strong></dt>
<dd>Unable to allocate internal system object.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOLOCK (26)</em></td>
<td align="left" valign="top">Unable to allocate internal system object.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ECONVERT -->
<!-- ============================================================== -->
<dt><strong>ECONVERT</strong></dt>
<dd>Data conversion error.<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em>EIMERR_DATA_CONVERSION (13)</em></td>
<td align="left" valign="top">Error occurred when converting data between code
pages.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EINVAL -->
<!-- ============================================================== -->
<dt><strong>EINVAL</strong></dt>
<dd>Input parameter was not valid.<br>
<br>
<table cellpadding="5">
<!-- cols="40 60" -->
<tr>
<td align="left" valign="top" nowrap><em>EIMERR_ACCESS_USERTYPE_INVAL
(3)</em></td>
<td align="left" valign="top">Access user type is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_EIMLIST_SIZE (16)</em></td>
<td align="left" valign="top">Length of EimList is not valid. EimList must be
at least 20 bytes in length.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_HANDLE_INVAL (17)</em></td>
<td align="left" valign="top">EimHandle is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_PARM_REQ (34)</em></td>
<td align="left" valign="top">Missing required parameter. Please check API
documentation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_PTR_INVAL (35)</em></td>
<td align="left" valign="top">Pointer parameter is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_SPACE (41)</em></td>
<td align="left" valign="top">Unexpected error accessing parameter.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOMEM -->
<!-- ============================================================== -->
<dt><strong>ENOMEM</strong></dt>
<dd>Unable to allocate required space.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOMEM (27)</em></td>
<td align="left" valign="top">No memory available. Unable to allocate required
space.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOTCONN -->
<!-- ============================================================== -->
<dt><strong>ENOTCONN</strong></dt>
<dd>LDAP connection has not been made.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOT_CONN (31)</em></td>
<td align="left" valign="top">Not connected to LDAP. Use eimConnect() API and
try the request again.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EUNKNOWN -->
<!-- ============================================================== -->
<dt><strong>EUNKNOWN</strong></dt>
<dd>Unexpected exception.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_LDAP_ERR (23)</em></td>
<td align="left" valign="top">Unexpected LDAP error. %s</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_UNKNOWN (44)</em></td>
<td align="left" valign="top">Unknown error or unknown system state.</td>
</tr>
</table>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- U S A G E N O T E S -->
<!-- -->
<!-- ============================================================== -->
<!-- ============================================================== -->
<!-- -->
<!-- R E L A T E D I N F O R M A T I O N -->
<!-- -->
<!-- ============================================================== -->
<h3>Related Information</h3>
<ul>
<li><a href="eimaddaccess.htm">eimAddAccess()</a> --Add EIM Access<br>
<br>
</li>
<li><a href="eimremoveaccess.htm">eimRemoveAccess()</a> --Remove EIM Access<br>
<br>
</li>
<li><a href="eimlistaccess.htm">eimListAccess()</a> --List EIM User
Accesses<br>
<br>
</li>
<li><a href="eimqueryaccess.htm">eimQueryAccess()</a> --Query EIM Access<br>
<br>
</li>
</ul>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- E X A M P L E -->
<!-- -->
<!-- ============================================================== -->
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example lists all registries found.</p>
<pre>
#include &lt;eim.h&gt;
#include &lt;stddef.h&gt;
#include &lt;stdio.h&gt;
#include &lt;stdlib.h&gt;
void printListResults(EimList * list);
void printSubListData(char * fieldName,
void * entry,
int offset);
void printListData(char * fieldName,
void * entry,
int offset);
int main(int argc, char *argv[])
{
int rc;
char eimerr[100];
EimRC * err;
EimHandle * handle;
EimAccessUser user;
char listData[5000];
EimList * list = (EimList * ) listData;
<em>/* Get eim handle from input arg. */</em>
<em>/* This handle is already connected to EIM. */</em>
handle = (EimHandle *)argv[1];
<em>/* Set up error structure. */</em>
memset(eimerr,0x00,100);
err = (EimRC *)eimerr;
err-&gt;memoryProvidedByCaller = 100;
<em>/* Set up access user information */</em>
user.userType = EIM_ACCESS_DN;
user.user.dn="cn=pete,o=ibm,c=us";
<em>/* Get user accesses */</em>
if (0 != (rc = eimListUserAccess(handle,
&amp;user,
5000,
list,
err)))
{
printf("List user access error = %d", rc);
return -1;
}
<em>/* Print the results */</em>
printListResults(list);
return 0;
}
void printListResults(EimList * list)
{
int i;
EimUserAccess * entry;
EimListData * listData;
EimRegistryName * registry;
printf("___________\n");
printf(" bytesReturned = %d\n", list-&gt;bytesReturned);
printf(" bytesAvailable = %d\n", list-&gt;bytesAvailable);
printf(" entriesReturned = %d\n", list-&gt;entriesReturned);
printf(" entriesAvailable = %d\n", list-&gt;entriesAvailable);
printf("\n");
if (list-&gt;entriesReturned &gt; 1)
printf("Unexpected number of entries returned.\n");
entry = (EimUserAccess *)((char *)list + list-&gt;firstEntry);
if (EIM_ACCESS_YES == entry-&gt;eimAdmin)
printf(" EIM Admin.\n");
if (EIM_ACCESS_YES == entry-&gt;eimRegAdmin)
printf(" EIM Reg Admin.\n");
if (EIM_ACCESS_YES == entry-&gt;eimIdenAdmin)
printf(" EIM Iden Admin.\n");
if (EIM_ACCESS_YES == entry-&gt;eimMappingLookup)
printf(" EIM Mapping Lookup.\n");
if (EIM_ACCESS_YES == entry-&gt;eimCredentialData)
printf(" EIM Credential Data.\n");
printf(" Registries:\n");
printSubListData("Registry names",
entry,
offsetof(EimUserAccess, registries));
printf("\n");
}
void printSubListData(char * fieldName,
void * entry,
int offset)
{
int i;
EimSubList * subList;
EimRegistryName * subentry;
<em>/* Address the EimSubList object */</em>
subList = (EimSubList *)((char *)entry + offset);
if (subList-&gt;listNum &gt; 0)
{
subentry = (EimRegistryName *)((char *)entry + subList-&gt;disp);
for (i = 0; i &lt; subList-&gt;listNum; i++)
{
<em>/* Print out results */</em>
printListData(fieldName,
subentry,
offsetof(EimRegistryName, name));
<em>/* advance to next entry */</em>
subentry = (EimRegistryName *)((char *)subentry +
subentry-&gt;nextEntry);
}
}
}
void printListData(char * fieldName,
void * entry,
int offset)
{
EimListData * listData;
char * data;
int dataLength;
printf(" %s = ",fieldName);
<em>/* Address the EimListData object */</em>
listData = (EimListData *)((char *)entry + offset);
<em>/* Print out results */</em>
data = (char *)entry + listData-&gt;disp;
dataLength = listData-&gt;length;
if (dataLength &gt; 0)
printf("%.*s\n",dataLength, data);
else
printf("Not found.\n");
}
</pre>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- F O O T E R -->
<!-- -->
<!-- ============================================================== -->
<hr>
API introduced: V5R2
<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>
Reference in New Issue View Git Blame Copy Permalink