127 lines
13 KiB
HTML
127 lines
13 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>Enterprise Identity Mapping (EIM) APIs</title>
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Begin Header Records ========================================= -->
|
||
|
|
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- 021014 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 030107 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 031007 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 031106 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 031111 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- 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>Enterprise Identity Mapping (EIM) APIs</h2>
|
||
|
|
|
||
|
|
<p>Enterprise Identity Mapping (EIM) provides the mechanics for cross-platform
|
||
|
|
single sign-on enablement. Applications can use EIM to perform identity mapping
|
||
|
|
lookup operations to authenticate the user to multiple systems in the enterprise.</p>
|
||
|
|
|
||
|
|
<p>For more information on this topic, see <a href="../rzalv/rzalvmst.htm">Enterprise
|
||
|
|
Identity Mapping</a>.</p>
|
||
|
|
|
||
|
|
<p>For information on the EIM return code structure, see
|
||
|
|
<a href="eimrc.htm">EimRC--EIM Return Code Parameter</a>.</p>
|
||
|
|
|
||
|
|
<p>The Enterprise Identity Mapping APIs are:</p>
|
||
|
|
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
|
||
|
|
<!-- Updates made in this section *will* be overlaid by automated tools -->
|
||
|
|
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
|
||
|
|
<!--***************API BEGIN PASTE***************-->
|
||
|
|
<ul>
|
||
|
|
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="eimaddgroupregistry.htm">Add a Group Registry to the EIM domain</A> (eimAddGroupRegistry()) adds a group registry to the EIM domain. <img src="deltaend.gif" ALT="End of change" border="0"></li>
|
||
|
|
<li><A HREF="eimaddsystemregistry.htm">Add a System Registry to the EIM Domain</A> (eimAddSystemRegistry()) adds a system registry to the EIM domain.</li>
|
||
|
|
<li><A HREF="eimaddapplicationregistry.htm">Add an Application Registry to the EIM Domain</A> (eimAddApplicationRegistry()) adds an application registry to the EIM domain.</li>
|
||
|
|
<li><A HREF="eimaddaccess.htm">Add EIM Access</A> (eimAddAccess()) adds the user to the EIM access group identified by the access type.</li>
|
||
|
|
<li><A HREF="eimaddassociation.htm">Add EIM Association</A> (eimAddAssociation()) associates a local identity in a specified user registry with an EIM identifier.</li>
|
||
|
|
<li><A HREF="eimaddidentifier.htm">Add EIM Identifier</A> (eimAddIdentifier()) creates an identifier in EIM related to a specific person or entity within an enterprise.</li>
|
||
|
|
<li><A HREF="eimaddpolicyassociation.htm">Add EIM Policy Association</A> (eimAddPolicyAssociation()) adds the specified policy association to the domain.</li>
|
||
|
|
<li><A HREF="eimaddpolicyfilter.htm">Add EIM Policy Filter</A> (eimAddPolicyFilter()) adds a policy filter value to the domain.</li>
|
||
|
|
<li><A HREF="eimchangedomain.htm">Change an EIM Domain Object</A> (eimChangeDomain()) changes an attribute for the EIM domain entry identified by domainName.</li>
|
||
|
|
<li><A HREF="eimchangeidentifier.htm">Change EIM Identifier</A> (eimChangeIdentifier()) modifies an existing EIM identifier.</li>
|
||
|
|
<li><A HREF="eimchangeregistry.htm">Change EIM Registry</A> (eimChangeRegistry()) changes the attribute of a registry participating in the EIM domain.</li>
|
||
|
|
<li><A HREF="eimchangeregistryalias.htm">Change EIM Registry Alias</A> (eimChangeRegistryAlias()) allows you to add or remove a registry alias for the defined registry.</li>
|
||
|
|
<li><A HREF="eimchangeregistryuser.htm">Change EIM Registry User</A> (eimChangeRegistryUser()) changes the attributes of a registry user entry.</li>
|
||
|
|
<li><A HREF="eimconnect.htm">Connect to EIM Domain</A> (eimConnect()) is used to connect to the EIM domain that is configured for this platform.</li>
|
||
|
|
<li><A HREF="eimconnecttomaster.htm">Connect to EIM Master Domain</A> (eimConnectToMaster()) is used to connect to the EIM master domain controller.</li>
|
||
|
|
<li><A HREF="eimerr2string.htm">Convert EimRC into an Error Message</A> (eimErr2String()) converts the EIM return code structure returned by an EIM function into a NULL-terminated error message string.</li>
|
||
|
|
<li><A HREF="eimcreatedomain.htm">Create an EIM Domain Object</A> (eimCreateDomain()) creates an EIM domain object on the specified EIM domain controller.</li>
|
||
|
|
<li><A HREF="eimcreatehandle.htm">Create an EIM Handle</A> (eimCreateHandle()) is used to allocate an EimHandle structure, which is used to identify the EIM connection and to maintain per-connection information.</li>
|
||
|
|
<li><A HREF="eimdeletedomain.htm">Delete an EIM Domain Object</A> (eimDeleteDomain()) deletes the EIM domain information.</li>
|
||
|
|
<li><A HREF="eimdestroyhandle.htm">Destroy an EIM Handle</A> (eimDestroyHandle()) is used to deallocate an EimHandle structure.</li>
|
||
|
|
<li><A HREF="eimformatpolicyfilter.htm">Format EIM Policy Filter</A> (eimFormatPolicyFilter()) generates a policy filter value.</li>
|
||
|
|
<li><A HREF="eimformatuseridentity.htm">Format EIM User Identity</A> (eimFormatUserIdentity()) formats user identity information for use with other EIM functions.</li>
|
||
|
|
<li><A HREF="eimgetassociatedidentifiers.htm">Get Associated EIM Identifiers</A> (eimGetAssociatedIdentifiers()) returns a list of the identifiers.</li>
|
||
|
|
<li><A HREF="eimgetattribute.htm">Get EIM Attributes</A> (eimGetAttribute()) is used to get attributes for this EIM handle.</li>
|
||
|
|
<li><A HREF="qsygeteimconnectinfo.htm">Get EIM Connect Information</A> (QsyGetEIMConnectInfo()) returns the connection information that will be used by the i5/OS operating system when it needs to connect to the EIM domain that is configured for this system or for the master system.</li>
|
||
|
|
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="qsygeteimhandle.htm">Get EIM Handle Connected For System</A> (QsyGetEIMHandle()) allocates an EimHandle structure that is connected to EIM. <img src="deltaend.gif" ALT="End of change" border="0"></li>
|
||
|
|
<li><A HREF="eimgetregistrynamefromalias.htm">Get EIM Registry Name from an Alias</A> (eimGetRegistryNameFromAlias()) returns a list of registry names that match the search criteria provided by<em>aliasType</em>and<em>aliasValue</em>.</li>
|
||
|
|
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="eimgettgtcredsfromidentifier.htm">Get EIM Target Identities and Credentials from the Identifier</A> (eimGetTgtCredsFromIdentifier()) gets the target identity or identities and credentials for the specified registry that is associated with the specified EIM identifier. <img src="deltaend.gif" ALT="End of change" border="0"></li>
|
||
|
|
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="eimgettargetcredsfromsource.htm">Get EIM Target Identities and Credentials from the Source</A> (eimGetTargetCredsFromSource()) gets the target identity(ies) and credentials associated with the source identity as defined by source registry name and source registry user. <img src="deltaend.gif" ALT="End of change" border="0"></li>
|
||
|
|
<li><A HREF="eimgettargetfromidentifier.htm">Get EIM Target Identities from the Identifier</A> (eimGetTargetFromIdentifier()) gets the target identity or identities for the specified registry that is associated with the specified EIM identifier.</li>
|
||
|
|
<li><A HREF="eimgettargetfromsource.htm">Get EIM Target Identities from the Source</A> (eimGetTargetFromSource()) gets the target identity or identies associated with the source identity as defined by source registry name and source registry user.</li>
|
||
|
|
<li><A HREF="eimgetversion.htm">Get EIM Version</A> (eimGetVersion()) returns the EIM version.</li>
|
||
|
|
<li><A HREF="eimlistaccess.htm">List EIM Access</A> (eimListAccess()) lists the users that have the specified EIM access type.</li>
|
||
|
|
<li><A HREF="eimlistassociations.htm">List EIM Associations</A> (eimListAssociations()) returns a list of associations for a given EIM identifier.</li>
|
||
|
|
<li><A HREF="eimlistdomains.htm">List EIM Domain Objects</A> (eimListDomains()) can be used to list information for a single EIM domain or list information for all EIM domains that can be reached from this platform in the network.</li>
|
||
|
|
<li><A HREF="eimlistidentifiers.htm">List EIM Identifiers</A> (eimListIdentifiers()) returns a list of identifiers in the EIM domain.</li>
|
||
|
|
<li><A HREF="eimlistpolicyfilters.htm">List EIM Policy Filters</A> (eimListPolicyFilters()) lists the policy filters for the domain.</li>
|
||
|
|
<li><A HREF="eimlistregistries.htm">List EIM Registries</A> (eimListRegistries()) lists the user registries participating in the EIM domain.</li>
|
||
|
|
<li><A HREF="eimlistregistryaliases.htm">List EIM Registry Aliases</A> (eimListRegistryAliases()) returns a list of all the aliases defined for a particular registry.</li>
|
||
|
|
<li><A HREF="eimlistregistryassociations.htm">List EIM Registry Associations</A> (eimListRegistryAssociations()) lists association information for the registry or domain.</li>
|
||
|
|
<li><A HREF="eimlistregistryusers.htm">List EIM Registry Users</A> (eimListRegistryUsers()) lists the users in a particular registry that have target associations defined.</li>
|
||
|
|
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="eimlistregistryuserscreds.htm">List EIM Registry Users Credentials</A> (eimListRegistryUsersCreds()) lists the users in a particular registry that have target associations defined. <img src="deltaend.gif" ALT="End of change" border="0"></li>
|
||
|
|
<li><A HREF="eimlistuseraccess.htm">List EIM User Access</A> (eimListUserAccess()) lists the access groups of which this user is a member.</li>
|
||
|
|
<li><A HREF="eimqueryaccess.htm">Query EIM Access</A> (eimQueryAccess()) queries to see if the user has the specified access.</li>
|
||
|
|
<li><A HREF="eimremoveregistry.htm">Remove a Registry from the EIM Domain</A> (eimRemoveRegistry()) removes a currently participating registry from the EIM domain.</li>
|
||
|
|
<li><A HREF="eimremoveaccess.htm">Remove EIM Access</A> (eimRemoveAccess()) removes the user from the EIM access group identified by the access type.</li>
|
||
|
|
<li><A HREF="eimremoveassociation.htm">Remove EIM Association</A> (eimRemoveAssociation()) removes an association for a local identity in a specified user registry with an EIM identifier.</li>
|
||
|
|
<li><A HREF="eimremoveidentifier.htm">Remove EIM Identifier</A> (eimRemoveIdentifier()) removes an EIM identifier and all of its associated mappings from the EIM domain.</li>
|
||
|
|
<li><A HREF="eimremovepolicyassociation.htm">Remove EIM Policy Association</A> (eimRemovePolicyAssociation()) removes the specified policy association form the domain.</li>
|
||
|
|
<li><A HREF="eimremovepolicyfilter.htm">Remove EIM Policy Filter</A> (eimRemovePolicyFilter()) removes a policy filter value from the domain.</li>
|
||
|
|
<li><A HREF="eimretrieveconfiguration.htm">Retrieve EIM Configuration</A> (eimRetrieveConfiguration()) retrieves the EIM configuration information for this system.</li>
|
||
|
|
<li><A HREF="eimsetattribute.htm">Set EIM Attributes</A> (eimSetAttribute()) is used to set attributes in the EIM handle structure.</li>
|
||
|
|
<li><A HREF="eimsetconfiguration.htm">Set EIM Configuration</A> (eimSetConfiguration()) sets the configuration information for use by the system.</li>
|
||
|
|
<li><A HREF="eimsetconfigurationext.htm">Set EIM Configuration Extended</A> (eimSetConfigurationExt()) sets the configuration information for use by the system.</li>
|
||
|
|
<li><A HREF="qsyseteimconnectinfo.htm">Set EIM Connect Information</A> (QsySetEIMConnectInfo()) defines the connection information that will be used by the i5/OS operating system when it needs to connect to the EIM domain that is configured for this system or for the master system.</li>
|
||
|
|
</ul>
|
||
|
|
<!--***************API END PASTE***************-->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<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>
|