eimListRegistryUsersCreds()-- List
EIM Registry Users CredentialseimListRegistryUsersCreds()-- List
EIM Registry Users Credentials
#include <eim.h>
int eimListRegistryUsersCreds(EimHandle * eim,
char * registryName,
char * registryUserName,
unsigned int lengthOfListData,
EimList * listData,
EimRC * eimrc)
Service Program Name: QSYS/QSYEIM The eimListRegistryUsersCreds() function lists the users in a particular registry that have target associations defined.
EIM version 3 must be supported by the local EIM APIs to use this API (see eimGetVersion()--Get EIM Version).
The list returned contains only the information that the user has authority to access.
Note that the EIM Credential Data access group does not have access to the general registry user data. If a user is a member of the EIM Credential Data access group, then the user must also be a member of one of the access groups that has access to the general registry user data.
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 EimRegistryUser structures. firstEntry is used to get to the first EimRegistryUser structure in the linked list.
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;
EimRegistryUser structure:
typedef struct EimRegistryUser
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure. */
EimListData registryUserName; /* Name */
EimListData description; /* Description */
EimSubList additionalInfo; /* EimAddlInfo sublist */
EimSubList credentialInfo; /* EimCredentialInfo sublist */
} EimRegistryUser;
Registry users may have several additional attributes. In the EimRegistryUser structure, additionalInfo gives addressability to the first EimAddlInfo structure that contains a linked list of attributes.
EimAddlInfo structure:
typedef struct EimAddlInfo
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure. */
EimListData addlInfo; /* Additional info */
} EimAddlInfo;
Registry users may have several types of credentials. In the EimRegistryUser structure, credentialInfo gives addressability to the first EimCredentialInfo structure that contains a linked list of credentials.
If there is credential information for the registry user, but the caller is not authorized to access the credential information, the EimCredentialInfo structure will be returned with the type and status fields filled in. The data field will not be returned (length and disp will be 0). If there is no credential information, the EimCredentialInfo structure will not be returned in the credentialInfo sublist.
EimCredentialInfo structure:
typedef struct EimCredentialInfo
{
unsigned int nextEntry; /* Displacement to next entry. This
byte offset is relative to the
start of this structure. */
enum EimCredentialType type; /* Credential type */
enum EimStatus status; /* Credential status
0 = not enabled
1 = enabled */
EimListData data; /* Credential data */
} EimCredentialInfo;
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;
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.
| EIMERR_ACCESS (1) | Insufficient access to EIM data. |
| EIMERR_NOREG (28) | EIM Registry not found or insufficient access to EIM data. |
| EIMERR_NOLOCK (26) | Unable to allocate internal system object. |
| EIMERR_DATA_CONVERSION (13) | Error occurred when converting data between code pages. |
| 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_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. |
| EIMERR_FUNCTION_NOT_SUPPORTED (70) | The specified function is not supported by the EIM version. |
| EIMERR_NOMEM (27) | No memory available. Unable to allocate required space. |
| EIMERR_NOT_CONN (31) | Not connected to LDAP. Use eimConnect() API and try the request again. |
| 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. |
See Code disclaimer information for information pertaining to code examples.
The following example lists all users and credentials in the specified registry.
#include <eim.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
void printListResults(EimList * list);
void printSubListData(char * fieldName,
void * entry,
int offset);
void printCredSubListData(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;
char listData[1000];
EimList * list = (EimList * ) listData;
/* 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;
/* Get registry user */
if (0 != (rc = eimListRegistryUsersCreds(handle,
"MyRegistry",
NULL,
1000,
list,
err)))
{
printf("List registry users credentials error = %d", rc);
return -1;
}
/* Print the results */
printListResults(list);
return 0;
}
void printListResults(EimList * list)
{
int i;
EimRegistryUser * 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 = (EimRegistryUser *)((char *)list + list->firstEntry);
for (i = 0; i < list->entriesReturned; i++)
{
printf("\n");
printf("===============\n");
printf("Entry %d.\n", i);
/* Print out results */
printListData("Registry user name",
entry,
offsetof(EimRegistryUser, registryUserName));
printListData("description",
entry,
offsetof(EimRegistryUser, description));
printSubListData("Additional information",
entry,
offsetof(EimRegistryUser, additionalInfo));
printCredSubListData("Credential information",
entry,
offsetof(EimRegistryUser, credentialInfo));
/* advance to next entry */
entry = (EimRegistryUser *)((char *)entry + entry->nextEntry);
}
printf("\n");
}
void printSubListData(char * fieldName,
void * entry,
int offset)
{
int i;
EimSubList * subList;
EimAddlInfo * subentry;
/* Address the EimSubList object */
subList = (EimSubList *)((char *)entry + offset);
if (subList->listNum > 0)
{
subentry = (EimAddlInfo *)((char *)entry + subList->disp);
for (i = 0; i < subList->listNum; i++)
{
/* Print out results */
printListData(fieldName,
subentry,
offsetof(EimAddlInfo, addlInfo));
/* advance to next entry */
subentry = (EimAddlInfo *)((char *)subentry +
subentry->nextEntry);
}
}
}
void printCredSubListData(char * fieldName,
void * entry,
int offset)
{
int i;
EimSubList * subList;
EimCredentialInfo * subentry;
/* Address the EimSubList object */
subList = (EimSubList *)((char *)entry + offset);
if (subList->listNum > 0)
{
subentry = (EimCredentialInfo *)((char *)entry + subList->disp);
for (i = 0; i < subList->listNum; i++)
{
/* Print out results */
printf(" Credential type = %d.\n",subentry->type);
printf(" Credential status = %d.\n",subentry->status);
/* Credential data is not printed. */
/* advance to next entry */
subentry = (EimCredentialInfo *)((char *)subentry +
subentry->nextEntry);
}
}
}
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");
}
| Top | Security APIs | APIs by category |