AREA API data structure
The AREA API data structure returns user login information from the AREA plug-in to the through AREAResponseStruct structure. AREAResponseStruct contains information about login status (whether the login attempt succeeded or failed or the user is unknown), license information for modifying entries and performing full text search (FTS), and message information that can be displayed to a user or logged to a file (aruser.log).
If you configure the system to cross-reference a blank password, the AREAResponseStruct element that the AREA plug-in returns overrides the related value in the user entry on the User form. For example, if the plug-in returns a value for the groups element of AREAResponseStruct, those groups override the groups in the user entry on the User form.
The AREA plug-in cannot return a fixed license (AR_LICENSE_TYPE_FIXED). Users must have a fixed license selected in their entry in the User form.
The AREAResponseStruct structure is defined in the area.h file.
An AREA plug-in implementation must use the data structure to return a response. The structure contains the following elements:
* BMC Remedy Alert is no longer shipped with .
The licenseMask information is necessary because the license information normally contained in the User form is overridden when you use external authentication. This is relevant in situations where some of your users are listed in the User form and some are authenticated externally.
This is the AREA response data structure:
typedef struct AREAResponseStruct {
unsigned int licenseMask; /* AREA_LICENSE_MASK_* */
unsigned int licenseWrite;/* AR_LICENSE_TYPE_* from AR API */
unsigned int licenseFTS; /* AR_LICENSE_TYPE_* from AR API */
unsigned int licenseRes1; /* AR_LICENSE_TYPE_* from AR API */
char *licenseApps; /* AR_LICENSE_TYPE_* from AR API */
char *groups; /* semi-colon separated list*/
unsigned int notifyMech; /* AR_NOTIFY_* from AR API */
char *email;
unsigned int loginStatus; /* AREA_LOGIN_* */
char *messageText; /* text seen by user */
char *logText; /* text placed in user log */
ARTimestamp *modTime;
AREAResponseStruct;