eimGetTargetFromIdentifier() --Get EIM Target Identities from the Identifier
Syntax
#include <eim.h> int eimGetTargetFromIdentifier(EimHandle * eim, EimIdentifierInfo * idName, char * targetRegistryName, char * additionalInformation, unsigned int lengthOfListData, EimList * listData, EimRC * eimrc)Service Program Name: QSYS/QSYEIM
Default Public Authority: *USE
Threadsafe: Yes
The eimGetTargetFromIdentifier() function gets the target identity or identities for the specified registry that is associated with the specified EIM identifier.
See EIM Mapping Lookup Algorithm for the steps involved in a mapping lookup operation.
Authorities and Locks
- EIM Data
- 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:
- EIM Administrator
- EIM Registries Administrator
- EIM Identifiers Administrator
- EIM Mapping Lookup
- EIM authority to an individual registry
The list returned contains only the information that the user has authority to access.
Parameters
- eim (Input)
-
The EIM handle returned by a previous call to eimCreateHandle().
A valid connection is required for this function.
- idName (Input)
-
A structure that contains the name of the identifier for this lookup
operation. The layout of the EimIdentifierInfo structure follows:
enum EimIdType { EIM_UNIQUE_NAME, EIM_ENTRY_UUID, EIM_NAME }; typedef struct EimIdentifierInfo { union { char * uniqueName; char * entryUUID; char * name; } id; enum EimIdType idtype; } EimIdentifierInfo;
idtype indicates which identifier name is provided. Use of the uniqueName provides the best performance. Specifying an idtype of EIM_NAME does not guarantee that a unique EIM identifier will be found. Therefore, use of EIM_NAME may result in an error.
- targetRegistryName (Input)
-
The target registry for this lookup operation.
A NULL parameter indicates that the localRegistry
set by the eimSetConfiguration() API or the
eimSetConfigurationExt() API should be used.
- additionalInfo (Input)
-
Additional information that will be used as selection criteria for
this operation. This may be NULL.
- lengthOfListData (Input)
-
The number of bytes provided by the caller for the
listData parameter.
The minimum size required is 20 bytes. This parameter is passed by value.
- listData (Output)
-
A pointer to the EimList structure.
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 EimTargetIdentity structures. firstEntry is used to get to the first EimTargetIdentity structure in the linked list. Each EimTargetIdentity entry contains a user name returned by this lookup operation.
EimList structure:
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;
EimTargetIdentity structure:
typedef struct EimTargetIdentity { unsigned int nextEntry; /* Displacement to next entry. This byte offset is relative to the start of this structure. */ EimListData userName; /* User name */ enum EimAssociationType type; /* Association type */ EimListData sourceGroupRegistry;/* Source group registry name */ EimListData targetGroupRegistry;/* Target group registry name */ EimSubList credentialInfo; /* EimCredentialInfo sublist */ } EimTargetIdentity;
The sourceGroupRegistry will not be returned by this API. The targetGroupRegistry will be returned if the target identity was found using a target association to a group registry.
This API will always return 0 for the numbers of entries in the credentialInfo sublist. If you need access to the credential information, use the Get EIM Target Identities and Credentials from the Identifier (eimGetTgtCredsFromIdentifier) API.
EimSubList structure:
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;
EimListData structure:
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;
- eimrc (Input/Output)
-
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 EimRC--EIM Return Code
Parameter.
Return Value
The return value from the API. Following each return value is the list of possible values for the messageCatalogMessageID field in the eimrc parameter for that value.
- 0
- Request was successful.
- EACCES
- Access denied. Not enough permissions to access data.
EIMERR_ACCESS (1) Insufficient access to EIM data.
- EBADDATA
- eimrc is not valid.
- EBADNAME
- Registry or identifier not found or insufficient access to EIM data.
EIMERR_IDNAME_AMBIGUOUS (20) More than 1 EIM Identifier was found that matches the requested Identifier name. EIMERR_NOIDENTIFIER (25) EIM Identifier not found or insufficient access to EIM data. EIMERR_NOREG (28) EIM Registry not found or insufficient access to EIM data.
- EBUSY
- Unable to allocate internal system object.
EIMERR_NOLOCK (26) Unable to allocate internal system object.
- ECONVERT
- Data conversion error.
EIMERR_DATA_CONVERSION (13) Error occurred when converting data between code pages.
- EINVAL
- Input parameter was not valid.
EIMERR_EIMLIST_SIZE (16) Length of EimList is not valid. EimList must be at least 20 bytes in length. EIMERR_HANDLE_INVAL (17) EimHandle is not valid. EIMERR_IDNAME_TYPE_INVAL (52) The EimIdType value is not valid. EIMERR_PARM_REQ (34) Missing required parameter. Please check API documentation. EIMERR_PTR_INVAL (35) Pointer parameter is not valid. EIMERR_SPACE (41) Unexpected error accessing parameter.
- ENOMEM
- Unable to allocate required space.
EIMERR_NOMEM (27) No memory available. Unable to allocate required space.
- ENOTCONN
- LDAP connection has not been made.
EIMERR_NOT_CONN (31) Not connected to LDAP. Use eimConnect() API and try the request again.
- EUNKNOWN
- Unexpected exception.
EIMERR_LDAP_ERR (23) Unexpected LDAP error. %s EIMERR_UNEXP_OBJ_VIOLATION (56) Unexpected object violation. EIMERR_UNKNOWN (44) Unknown error or unknown system state.
Related Information
- eimGetTargetFromSource()
--Get EIM Target Identities from the Source
- eimGetTgtCredsFromIdentifier()
--Get EIM Target Identities and Credentials from the Identifier
Example
The following example will get the list of users in the target registry, MyRegistry, that are associated with the specified identifier.
Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.
#include <eim.h> #include <stddef.h> #include <stdio.h> #include <stdlib.h> void printAssociationType(int type); void printListResults(EimList * list); void printListData(char * fieldName, void * entry, int offset); int main(int argc, char *argv[]) { int rc; char eimerr[100]; EimRC * err; EimHandle * handle; char listData[1000]; EimList * list = (EimList * ) listData; EimIdentifierInfo x; /* Get eim handle from input arg. */ /* This handle is already connected to EIM. */ handle = (EimHandle *)argv[1]; /* Set up error structure. */ memset(eimerr,0x00,100); err = (EimRC *)eimerr; err->memoryProvidedByCaller = 100; /* Set up identifier information */ x.idtype = EIM_UNIQUE_NAME; x.id.uniqueName = "mjones"; if (0 != (rc = eimGetTargetFromIdentifier(handle, &x, "MyRegistry", NULL, 1000, list, err))) { printf("Get Target from identifier error = %d", rc); return -1; } printListResults(list); return 0; } void printListResults(EimList * list) { int i; EimTargetIdentity * entry; printf("___________\n"); printf(" bytesReturned = %d\n", list->bytesReturned); printf(" bytesAvailable = %d\n", list->bytesAvailable); printf(" entriesReturned = %d\n", list->entriesReturned); printf(" entriesAvailable = %d\n", list->entriesAvailable); printf("\n"); entry = (EimTargetIdentity *)((char *)list + list->firstEntry); for (i = 0; i < list->entriesReturned; i++) { printf("\n"); printf("===============\n"); printf("Entry %d.\n", i); /* Print out results */ printListData("target user", entry, offsetof(EimTargetIdentity, userName)); printAssociationType(entry->type); printListData("target group registry", entry, offsetof(EimTargetIdentity, targetGroupRegistry)); /* advance to next entry */ entry = (EimTargetIdentity *)((char *)entry + entry->nextEntry); } printf("\n"); } void printListData(char * fieldName, void * entry, int offset) { EimListData * listData; char * data; int dataLength; printf(" %s = ",fieldName); /* Address the EimListData object */ listData = (EimListData *)((char *)entry + offset); /* Print out results */ data = (char *)entry + listData->disp; dataLength = listData->length; if (dataLength > 0) printf("%.*s\n",dataLength, data); else printf("Not found.\n"); } void printAssociationType(int type) { switch(type) { case EIM_TARGET: printf(" Target Association.\n"); break; case EIM_DEFAULT_DOMAIN_POLICY: printf(" Default Domain Policy Association.\n"); break; default: printf("ERROR - unknown association type.\n"); break; } }
API introduced: V5R2
[ Back to top | Security APIs | APIs by category ]