Enterprise Identity Mapping (EIM) APIs

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.

For more information on this topic, see Enterprise Identity Mapping.

For information on the EIM return code structure, see EimRC--EIM Return Code Parameter.

The Enterprise Identity Mapping APIs are:

• Add a Group Registry to the EIM domain (eimAddGroupRegistry()) adds a group registry to the EIM domain. 
• Add a System Registry to the EIM Domain (eimAddSystemRegistry()) adds a system registry to the EIM domain.
• Add an Application Registry to the EIM Domain (eimAddApplicationRegistry()) adds an application registry to the EIM domain.
• Add EIM Access (eimAddAccess()) adds the user to the EIM access group identified by the access type.
• Add EIM Association (eimAddAssociation()) associates a local identity in a specified user registry with an EIM identifier.
• Add EIM Identifier (eimAddIdentifier()) creates an identifier in EIM related to a specific person or entity within an enterprise.
• Add EIM Policy Association (eimAddPolicyAssociation()) adds the specified policy association to the domain.
• Add EIM Policy Filter (eimAddPolicyFilter()) adds a policy filter value to the domain.
• Change an EIM Domain Object (eimChangeDomain()) changes an attribute for the EIM domain entry identified by domainName.
• Change EIM Identifier (eimChangeIdentifier()) modifies an existing EIM identifier.
• Change EIM Registry (eimChangeRegistry()) changes the attribute of a registry participating in the EIM domain.
• Change EIM Registry Alias (eimChangeRegistryAlias()) allows you to add or remove a registry alias for the defined registry.
• Change EIM Registry User (eimChangeRegistryUser()) changes the attributes of a registry user entry.
• Connect to EIM Domain (eimConnect()) is used to connect to the EIM domain that is configured for this platform.
• Connect to EIM Master Domain (eimConnectToMaster()) is used to connect to the EIM master domain controller.
• Convert EimRC into an Error Message (eimErr2String()) converts the EIM return code structure returned by an EIM function into a NULL-terminated error message string.
• Create an EIM Domain Object (eimCreateDomain()) creates an EIM domain object on the specified EIM domain controller.
• Create an EIM Handle (eimCreateHandle()) is used to allocate an EimHandle structure, which is used to identify the EIM connection and to maintain per-connection information.
• Delete an EIM Domain Object (eimDeleteDomain()) deletes the EIM domain information.
• Destroy an EIM Handle (eimDestroyHandle()) is used to deallocate an EimHandle structure.
• Format EIM Policy Filter (eimFormatPolicyFilter()) generates a policy filter value.
• Format EIM User Identity (eimFormatUserIdentity()) formats user identity information for use with other EIM functions.
• Get Associated EIM Identifiers (eimGetAssociatedIdentifiers()) returns a list of the identifiers.
• Get EIM Attributes (eimGetAttribute()) is used to get attributes for this EIM handle.
• Get EIM Connect Information (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.
• Get EIM Handle Connected For System (QsyGetEIMHandle()) allocates an EimHandle structure that is connected to EIM. 
• Get EIM Registry Name from an Alias (eimGetRegistryNameFromAlias()) returns a list of registry names that match the search criteria provided byaliasTypeandaliasValue.
• Get EIM Target Identities and Credentials from the Identifier (eimGetTgtCredsFromIdentifier()) gets the target identity or identities and credentials for the specified registry that is associated with the specified EIM identifier. 
• Get EIM Target Identities and Credentials from the Source (eimGetTargetCredsFromSource()) gets the target identity(ies) and credentials associated with the source identity as defined by source registry name and source registry user. 
• Get EIM Target Identities from the Identifier (eimGetTargetFromIdentifier()) gets the target identity or identities for the specified registry that is associated with the specified EIM identifier.
• Get EIM Target Identities from the Source (eimGetTargetFromSource()) gets the target identity or identies associated with the source identity as defined by source registry name and source registry user.
• Get EIM Version (eimGetVersion()) returns the EIM version.
• List EIM Access (eimListAccess()) lists the users that have the specified EIM access type.
• List EIM Associations (eimListAssociations()) returns a list of associations for a given EIM identifier.
• List EIM Domain Objects (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.
• List EIM Identifiers (eimListIdentifiers()) returns a list of identifiers in the EIM domain.
• List EIM Policy Filters (eimListPolicyFilters()) lists the policy filters for the domain.
• List EIM Registries (eimListRegistries()) lists the user registries participating in the EIM domain.
• List EIM Registry Aliases (eimListRegistryAliases()) returns a list of all the aliases defined for a particular registry.
• List EIM Registry Associations (eimListRegistryAssociations()) lists association information for the registry or domain.
• List EIM Registry Users (eimListRegistryUsers()) lists the users in a particular registry that have target associations defined.
• List EIM Registry Users Credentials (eimListRegistryUsersCreds()) lists the users in a particular registry that have target associations defined. 
• List EIM User Access (eimListUserAccess()) lists the access groups of which this user is a member.
• Query EIM Access (eimQueryAccess()) queries to see if the user has the specified access.
• Remove a Registry from the EIM Domain (eimRemoveRegistry()) removes a currently participating registry from the EIM domain.
• Remove EIM Access (eimRemoveAccess()) removes the user from the EIM access group identified by the access type.
• Remove EIM Association (eimRemoveAssociation()) removes an association for a local identity in a specified user registry with an EIM identifier.
• Remove EIM Identifier (eimRemoveIdentifier()) removes an EIM identifier and all of its associated mappings from the EIM domain.
• Remove EIM Policy Association (eimRemovePolicyAssociation()) removes the specified policy association form the domain.
• Remove EIM Policy Filter (eimRemovePolicyFilter()) removes a policy filter value from the domain.
• Retrieve EIM Configuration (eimRetrieveConfiguration()) retrieves the EIM configuration information for this system.
• Set EIM Attributes (eimSetAttribute()) is used to set attributes in the EIM handle structure.
• Set EIM Configuration (eimSetConfiguration()) sets the configuration information for use by the system.
• Set EIM Configuration Extended (eimSetConfigurationExt()) sets the configuration information for use by the system.
• Set EIM Connect Information (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.