FPCUserSet Object

The FPCUserSet object defines a set of users. A user set may contain a combination of Windows users that have Active Directory accounts and non-Windows users that are authenticated using an authentication scheme other than that of Active Directory. Examples of non-Windows users include RADIUS and SecurID users. The Windows users are assembled in an FPCAccounts collection that can be accessed through the Accounts property, and the non-Windows users are assembled in an FPCNonWindowsUsers collection that can be accessed through the NonWindowsUsers property. For more information about different kinds of users in Forefront TMG, see Defining Groups of Users.

Forefront TMG provides the following predefined user sets:

All Authenticated Users.
All Users.
System and Network Service.

Access rules and Web publishing rules (FPCPolicyRule objects) can be applied to specific user sets by including references to the applicable FPCUserSet objects in the FPCRefs collection held in the UserSets property of the FPCAccessProperties object and in the UserSets property of the FPCWebPublishingProperties object, respectively. When you apply a rule to a user set other than the All Users user set, Forefront TMG will block requests from users, including anonymous users, who fail to authenticate and prove whether they do or do not belong to the user set.

For VBScript code examples that show how to create a user set and how to add a user set to an access rule, see Adding an Access Rule and Controlling Access by a Schedule and a User Set.

The user sets to which the virtual private network (VPN) quarantine is not applied are specified by including references to the applicable FPCUserSet objects in the FPCRefs collection held in the UserSetsExcluded property of the FPCVpnQuarantineSettings object.

The FPCUserSet object is an element of an FPCUserSets collection, and a new user set can be created by calling the Add method of this 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 the object's data to and importing it from an XML document.

Methods

The FPCUserSet object does not define any methods.

Properties

The FPCUserSet object defines the following properties.

Property	Description
Accounts	Gets an FPCAccounts collection that contains the Active Directory user accounts included in the user set.
Description	Gets or sets the description of the set.
Name	Gets or sets the name of the user set.
NonWindowsUsers	Gets an FPCNonWindowsUsers collection that contains the users who are authenticated using an authentication scheme other than that of Active Directory in the user set.
Predefined	Gets a Boolean value that indicates whether the user set is predefined.

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	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects 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	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects 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	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects 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 collection that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCUserSet 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.