FPCAuthenticationSchemes Collection

The FPCAuthenticationSchemes collection holds a set of FPCAuthenticationScheme objects representing all of the authentication schemes that are defined for a Forefront TMG array and are available for use by Web listeners. For more information, see Authentication Methods.

By default, this collection contains the following authentication schemes that are supplied with Forefront TMG:

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.
LDAP. A predefined authentication scheme for authenticating domain users at workgroup Forefront TMG computers using the Lightweight Directory Access Protocol (LDAP) protocol.
RADIUS. A predefined authentication scheme for authenticating users using the RADIUS protocol.
SecurID. A predefined authentication scheme that enables forms-based (cookie) authentication using RSA SecurID.

The FPCAuthenticationSchemes collection is accessed through the AuthenticationSchemes property of an FPCRuleElements object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This collection inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCAuthenticationSchemes collection defines the following methods.

Method	Description
Add	Creates a new FPCAuthenticationScheme object in the collection and returns a reference to it.
Item	Retrieves the requested FPCAuthenticationScheme object from the collection.
Remove	Removes the specified FPCAuthenticationScheme object from the collection.

Properties

The FPCAuthenticationSchemes collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCAuthenticationScheme objects in the collection.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the properties of the collection and its elements can be imported from the specified XML document.
Export	Writes the stored values of all the properties of the collection and its elements to the specified XML document.
ExportToFile	Writes the stored values of all the properties of the collection and its elements to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Copies the values of all the properties of the collection and its elements from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all the properties of the collection and its elements from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Reads the values of all the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all the properties of the collection and its elements to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the collection. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the collection.

Interfaces for C++ Programming

This collection implements the IFPCAuthenticationSchemes interface.

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.