FPCAuthenticationScheme Object

The FPCAuthenticationScheme object represents an authentication scheme. Authentication schemes can be used instead of the built-in Windows authentication methods supported by Forefront TMG to authenticate Web requests. For more information, see Authentication Methods.

The following authentication schemes 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 authentication schemes that are available to a Web listener are specified by including references to the applicable FPCAuthenticationScheme objects in the FPCRefs collection held in the AuthenticationSchemes property of the FPCWebListenerProperties object.

This object is an element of an FPCAuthenticationSchemes collection, and a new object representing an authentication scheme can be created by calling the Add method of this collection.

Note  

A third-party authentication scheme can be added to Forefront TMG with a Web filter. Web filter registration should include registration of all the authentication schemes that the filter supports. Web filters register authentication schemes using the Add method of the FPCAuthenticationSchemes collection.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This object 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 an object's data to and importing it from XML documents.

Methods

The FPCAuthenticationScheme object does not define any methods.

Properties

The FPCAuthenticationScheme object defines the following properties.

Property	Description
Description	Gets or sets the description of the authentication scheme.
Namespace	Gets or sets the namespace of the authentication scheme.
Predefined	Gets a Boolean value that indicates whether the authentication scheme is predefined.
Provides	Gets or sets a value from the FpcAuthenticationSchemeProvides enumerated type that specifies whether the authentication scheme provides a user namespace and whether the authentication scheme provides an authentication method.
Services	Gets or sets a value from the FpcServiceTypes enumerated type that specifies which services can use the authentication scheme.
Vendor	Gets or sets the name of the vendor that supplied the authentication scheme.
Version	Gets or sets the version of the authentication scheme.

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 object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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 of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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 of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 object. 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 object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCAuthenticationScheme interface.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010