Authorization (ISecurity Interface)

GetInternalLoginUserInfo

Gets availability information and internal authentication settings for the specified user.

Category: Internal authentication methods

Interface version: ISecurity 1.1

GetInternalLoginUserInfo(personName,hasInternalLogin,isDisabled,bypassStrength,
bypassHistory,useStdExpirationDays,expirationDays,bypassLockout,
bypassInactivitySuspension,doesAccountExpire,accountExpirationDate,
lastPasswordChange,lastLogin,numFailuresSinceLogin,
lastLockout,isLockedOut,isExpired,isSuspend,isAccountExpired);

Parameters

Parameter	Type	Direction	Description
personName	string	in	Specifies the Name= value of the Person object for which the InternalLogin is defined. Unlike in other security methods, the Name= value is specified as simplyName.
hasInternalLogin	boolean	out	Returns T or F, indicating whether the specified user has an InternalLogin object defined.
bypassStrength	boolean	out	Returns T or F, indicating whether a custom password complexity policy is defined.
bypassHistory	boolean	out	Returns T or F, indicating whether a custom history requirement is defined.
useStdExpirationDays	boolean	out	Returns T or F, indicating whether the InternalLogin has a password expiration date.
expirationDays	int	out	Specifies the expiration period.
bypassLockout	boolean	out	Returns T or F, indicating whether a custom lockout policy is defined.
bypassInactivitySuspension	boolean	out	Returns T or F, indicating whether a custom inactivity suspension policy is defined.
doesAccountExpire	boolean	out	Returns T or F, indicating whether the internal account has an expiration date.
accountExpirationDate	datetime	out	Returns the account expiration date if one is defined.
lastPasswordChange	datetime	out	Returns a datetime value, indicating when the password was last changed.
lastLogin	datetime	out	Returns a datetime value, indicating the last time the login was used.
numFailuresSinceLogin	int	out	Returns a number, indicating the number of unsuccessful login attempts since the last successful login.
lastLockout	datetime	out	Returns a datetime value, indicating the last time the account was locked because of consecutive unsuccessful login attempts.
isLockedOut	boolean	out	Returns T or F, indicating whether the account is currently locked because of login failures.
isExpired	boolean	out	Returns T or F, indicating whether the password is currently expired.
isSuspended	boolean	out	Returns T or F, indicating whether the account is currently suspended because of inactivity.
isAccountExpired	boolean	out	Returns T or F, indicating whether the account is currently expired.

Details

Except for PERSONNAME, parameters are holders for receiving output values.

If an internal user account suddenly becomes unavailable, use the GetInternalLoginUserInfo method to determine why the account is unavailable. In addition to returning the specified Person object's internal authentication policy settings, output parameters indicate whether the account is active, disabled, expired, locked out because of unsuccessful authentication, or suspended because of inactivity.

Exceptions Thrown

The GetInternalLoginUserInfo method does not return any exceptions.

Examples

The following is a Java example of a GetInternalLoginUserInfo method call:

// Assumes a Person object with Name='Test1' exists
// and has an InternalLogin object associated with it
String personName ="Test1"';
BooleanHolder hasInternalLogin = new BooleanHolder();
BooleanHolder isDisabled  = new BooleanHolder();
BooleanHolder bypassStrength  = new BooleanHolder();
BooleanHolder bypassHistory  = new BooleanHolder();
BooleanHolder useStdExpirationDays = new BooleanHolder();
IntHolder expirationDays = new IntHolder();
BooleanHolder bypassLockout = new BooleanHolder();
BooleanHolder bypassInactivitySuspension = new BooleanHolder();
BooleanHolder doesAccountExpire = new BooleanHolder();
DateTimeHolder accountExpirationDate = new DateTimeHolder();         
DateTimeHolder lastPasswordChange = new DateTimeHolder();
DateTimeHolder lastLogin = new DateTimeHolder();
IntHolder numFailuresSinceLogin = new IntHolder();
DateTimeHolder lastLockout = new DateTimeHolder();
BooleanHolder isLockedOut = new BooleanHolder();
BooleanHolder isExpired = new BooleanHolder();
BooleanHolder isSuspended = new BooleanHolder();
BooleanHolder isAccountExpired = new BooleanHolder();
    
GetInternalLoginUserInfo( personName,
                                    hasInternalLogin, 
                                    isDisabled,
                                    bypassStrength,
                                    bypassHistory,
                                    useStdExpirationDays, 
                                    expirationDays, 
                                    bypassLockout,
                                    bypassInactivitySuspension, 
                                    doesAccountExpire, 
                                    accountExpirationDate, 
                                    lastPasswordChange, 
                                    lastLogin, 
                                    numFailuresSinceLogin,
                                    lastLockout, 
                                    isLockedOut, 
                                    isExpired,
                                    isSuspended, 
                                    isAccountExpired );

Related Methods

Top of Page