ESS_USERINFOID_T, ESS_GROUPINFOID_T

Stores information about a user or group. This structure is similar to ESS_USERINFOEX_T, with the addition of the ProviderName and connparam fields.

typedef struct ESS_USERINFOID_T
{
   ESS_USERNAME_T     Name;          
   ESS_USERNAME_T     ProviderName;
   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_USERINFOID_T, *ESS_PUSERINFOID_T, **ESS_PPUSERINFOID_T,
  ESS_GROUPINFOID_T, *ESS_PGROUPINFOID_T, **ESS_PPGROUPINFOID_T;
Data TypeFieldDescription
ESS_USERNAME_TNameUser name
ESS_USERNAME_TProviderNameName of the user directory. Example: @Native Directory
ESS_PASSWORD_TPasswordPassword 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_TAppNameName of the currently connected application (if applicable)
ESS_DBNAME_TDbNameName of the currently connected database (if applicable)
ESS_BOOL_TLoginFlag to indicate login status
ESS_USHORT_TTypeType of the structure. This field can contain the following value:
  • ESS_TYPE_USER

ESS_ACCESS_TAccessUser assigned default access privileges. Values can be any combination of the following bit values:
  • ESS_ACCESS_SUPER /* Supervisor, all bits set */

  • ESS_PRIV_APPCREATE /* App create/delete privilege */

  • ESS_PRIV_USERCREATE /* user create/delete privilege */

ESS_ACCESS_TMaxAccessUser's maximum access privileges (including individual access and access levels due to group membership)
ESS_DATE_TExpirationUser's password expiration date
ESS_TIME_TLastLoginDate of user's last successful login stated as Greenwich Mean Time
ESS_TIME_TDbConnectTimeLocal (server) time of database connection. Read-only. Cannot be set by EssSetUser.
ESS_USHORT_TFailCountCount of the failed login attempts since the last successful login
ESS_LOGINID_TLoginIdUser login identification tag
ESS_DESC_TDescriptionUser description
ESS_EMAIL_TEMailIDUser email address
ESS_BOOL_TLockedOutFlag indicating that the user is locked out
ESS_BOOL_TPwdChgNowFlag indicating that the user must change the password
ESS_PROTOCOL_TprotocolExternal authentication protocol.
ESS_CONNPARAM_TconnparamUnique identity attribute identifying a user or group in a directory. Example:
native://nvid=f0ed2a6d7fb07688:5a342200:1265973105c:-7f46?USER