FPCFormsBasedAuthenticationProperties object

Applies to: desktop apps only

The FPCFormsBasedAuthenticationProperties object holds the forms-based authentication configuration settings of a Web listener.

The configuration settings held in this object are applicable only if the AuthenticationSchemes property of the Web listener references one of the following authentication schemes:

• FBA with AD. A predefined authentication scheme that enables forms-based authentication using Active Directory.
• FBA with LDAP. A predefined authentication scheme that enables forms-based authentication of domain users using an LDAP server.
• FBA with RADIUS. A predefined authentication scheme that enables forms-based authentication using a RADIUS server.
• FBA with RADIUS OTP. A predefined authentication scheme that enables forms-based authentication using a RADIUS server in a one-time password (OTP) solution.
• SecurID. A predefined authentication scheme that enables forms-based (cookie) authentication using RSA SecurID.

The FPCFormsBasedAuthenticationProperties object is accessed through the FormsBasedAuthenticationProperties property of an FPCWebListenerProperties object.

Click here to see the Forefront TMG object hierarchy.

Members

The FPCFormsBasedAuthenticationProperties object has these types of members:

• Methods
• Properties

Methods

The FPCFormsBasedAuthenticationProperties object has these methods.

Method	Description
Refresh	Reads the values of the object's properties from persistent storage, discarding any changes that were not saved.
Save	Writes the current values of the object's properties to persistent storage.

 

Properties

The FPCFormsBasedAuthenticationProperties object has these properties.

Property	Access type	Description
ApplySessionTimeoutToNonBrowserClients	Read/write	Gets or sets a Boolean value that indicates whether the applicable session time-out period will be applied to non-browser clients.
ChangePasswordAllowed	Read/write	Gets or sets a Boolean value that indicates whether users using forms-based authentication may change their password.
ClientIPAddressSigningEnabled	Read/write	Gets or sets a Boolean value that indicates whether the client IP address is used for cookie validation.
CustomFormsDirectory	Read/write	Gets or sets the name of the folder where custom HTML forms are stored.
FBACookieName	Read/write	Gets or sets the cookie name used for forms-based authentication.
FormsLanguage	Read/write	Gets or sets the preferred language for the HTML forms.
IncludeDelegationCredentialsInLogonForm	Read/write	Gets or sets a Boolean value that indicates whether the logon form will include credentials for delegation to the published server.
PasswordExpirationWarningEnabled	Read/write	Gets or sets a Boolean value that indicates whether users will be warned if their password is about to expire.
PasswordExpirationWarningPeriod	Read-only	Gets the password expiration warning period, in days.
RequireSSLClientCertificate	Read/write	Gets or sets a Boolean value that indicates whether HTTPS requests sent without an SSL client certificate will be denied before the HTML form is presented to the user.
SecurIDAuthenticationProperties	Read-only	Gets an FPCSecurIDAuthenticationProperties object that holds the configuration settings for RSA SecurID authentication.
SessionTimeOutForPublicComputers	Read/write	Gets or sets the session time-out period for public computers.
SessionTimeOutForTrustedComputers	Read/write	Gets or sets the session time-out period for trusted computers.
SessionTimeOutUnitsForPublicComputers	Read/write	Gets or sets a value from the FpcTimeScale enumerated type that specifies the units of time in which the SessionTimeOutForPublicComputers property is expressed.
SessionTimeOutUnitsForTrustedComputers	Read/write	Gets or sets a value from the FpcTimeScale enumerated type that specifies the units of time in which the SessionTimeOutForTrustedComputers property is expressed.
UseAbsoluteCookieExpiration	Read/write	Gets or sets a Boolean value that indicates whether the session time-out periods for private and public computers will be treated as absolute.
UseBasicAuthenticationForNonBrowserClients	Read/write	Gets or sets a Boolean value that indicates whether Basic authentication may be used for non-browser clients.
UsePersistentCookies	Read/write	Gets or sets a value from the FpcUsePersistentCookiesComputerType enumerated type that specifies the types of client computers for which persistent cookies are allowed.

 

Interfaces for C++ Programming

This object implements the IFPCFormsBasedAuthenticationProperties interface.

Requirements

Minimum supported client	Windows Vista, None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010