GetInternalLoginSitePolicies

Short Description

Returns the active server-level internal authentication policies.

Category

Internal authentication methods

Interface Version

ISecurity 1.1

Syntax

GetInternalLoginSitePolicies(siteMinPasswordLength,siteIsDigitRequired,
siteIsMixedCaseRequired,siteSizeHistoryList,sitePasswordChangeDelayInMinutes,
siteExpirationDays,siteNumFailuresForLockout,siteLockoutInMinutes,
siteDaysToSuspension);

Parameters

Method Parameters
Parameter
Type
Direction
Description
siteMinPasswordLength
int
out
Specifies the minimum length for passwords in characters.
siteIsDigitRequired
boolean
out
Specifies whether passwords must include at least one digit.
siteIsMixedCaseRequired
boolean
out
Specifies whether passwords must include at least one uppercase letter and at least one lowercase letter.
siteSizeHistoryList
int
out
Specifies the number of previous passwords that are required to be saved before a password value can be reused.
sitePasswordChangeDelayInMinutes
int
out
Specifies the number of minutes that must elapse between password changes.
siteExpirationDays
int
out
Specifies the number of days after a password is set that the password expires.
siteNumFailuresForLockout
int
out
Specifies the number of consecutive unsuccessful logon attempts after which an account to be locked.
siteLockoutInMinutes
int
out
Specifies the number of minutes for which an account is locked following excessive login failures.
siteDaysToSuspension
int
out
Specifies the number of days after which an unused account is suspended.

Details

Parameters are holders for receiving output values, and all parameters are required. That is, the caller must specify all parameters to get values back. A caller cannot leave any variables empty to indicate that he or she doesn't want a value for that parameter.

Exceptions Thrown

The GetInternalLoginSitePolicies method does not return any exceptions.

Examples

The following is a Java example of a GetInternalLoginSitePolicies method call:
IntHolder siteMinPasswordLength = new IntHolder();
BooleanHolder siteIsDigitRequired = new BooleanHolder();
BooleanHolder siteIsMixedCaseRequired = new BooleanHolder();
IntHolder siteSizeHistoryList = new IntHolder();
IntHolder sitePasswordChangeDelayInMinutes = new IntHolder();
IntHolder siteExpirationDays = new IntHolder();
IntHolder siteNumFailuresForLockout = new IntHolder();
IntHolder siteLockoutInMinutes = new IntHolder();
IntHolder siteDaysToSuspension = new IntHolder();

iSecurity.GetInternalLoginSitePolicies( siteMinPasswordLength,
                              siteIsDigitRequired,
                              siteIsMixedCaseRequired,
                              siteSizeHistoryList,
                              sitePasswordChangeDelayInMinutes,
                              siteExpirationDays, 
                              siteNumFailuresForLockout,
                              siteLockoutInMinutes,
                              siteDaysToSuspension );