ESS_USERINFOEX_T

Stores information about a user or group. Some of the fields are specific to users and cannot be used for groups. The Access, Expiration, and PwdChgNow fields are the only fields in this structure that can be modified using the API.

This extended User Info structure is slightly different from the standardESS_USERINFO_T structure used by EssGetUser (see ESS_USERINFO_T, ESS_GROUPINFO_T). This extended structure is used by EssGetUserEx.

The fields are:

typedef struct ESS_USERINFOEX_T
{
ESS_USERNAME_T     Name;          
ESS_PASSWORD_T     Password;  
ESS_APPNAME_T      AppName;       
ESS_DBNAME_T       DbName;        
ESS_BOOL_T         Login;         
ESS_USHORT_T       Type;          
ESS_ACCESS_T       Access;        
ESS_ACCESS_T       MaxAccess;     
ESS_DATE_T         Expiration;    
ESS_TIME_T         LastLogin;     
ESS_TIME_T         DbConnectTime; 
ESS_USHORT_T       FailCount;     
ESS_LOGINID_T      LoginId;       
ESS_DESC_T         Description;   
ESS_EMAIL_T        EMailID;       
ESS_BOOL_T         LockedOut;        
ESS_BOOL_T         PwdChgNow;        
ESS_PROTOCOL_T     protocol;    
ESS_CONNPARAM_T    connparam;   
} ESS_USERINFOEX_T, *ESS_PUSERINFOEX_T, **ESS_PPUSERINFOEX_T;

Data Type	Field	Description
ESS_USERNAME_T	Name	Externally authenticed User name.
ESS_PASSWORD_T	Password	Password of externally authenticated user. This is used only when setting an externally authenticated user to the Essbase authenticated mechanisms. This password is ignored in other situations, including retrieving information from the server on the externally authenticated user.
ESS_APPNAME_T	AppName	Name of currently connected application (if applicable)
ESS_DBNAME_T	DbName	Name of the currently connected database(if applicable)
ESS_BOOL_T	Login	Flag to indicate login status (users only)
ESS_USHORT_T	Type	Type of the structure (user or group). This field can contain the following values: ESS_TYPE_USER ESS_TYPE_GROUP
ESS_ACCESS_T	Access	User or group assigned default access privileges. Values: any combination of the following bit values: ESS_ACCESS_SUPER /* Administrator, all bits set / ESS_PRIV_APPCREATE / App create/delete privilege / ESS_PRIV_USERCREATE / user create/delete privilege */
ESS_ACCESS_T	MaxAccess	User's maximum access privileges (users only, including individual access and access levels due to group membership.
ESS_DATE_T	Expiration	User's password expiration date.
ESS_TIME_T	LastLogin	Date of user's last successful login stated as Greenwich Mean Time (users only).
ESS_TIME_T	DbConnectTime	Local (server) time of database connection. Read-only. Cannot be set by EssSetUser.
ESS_USHORT_T	FailCount	Count of the failed login attempts since the last successful login (users only).
ESS_LOGINID_T	LoginId	The user login identification tag (users only) .
ESS_DESC_T	Description	User/group description.
ESS_EMAIL_T	EMailID	User/group email address.
ESS_BOOL_T	LockedOut	Flag that user is locked out.
ESS_BOOL_T	PwdChgNow	Flag that user must change password.
ESS_PROTOCOL_T	protocol	External authentication protocol.
ESS_CONNPARAM_T	connparam	External authentication connection.