This documentation is archived and is not being maintained.

GenericPrincipal Class

Represents a generic principal.


Namespace:  System.Security.Principal
Assembly:  mscorlib (in mscorlib.dll)

public class GenericPrincipal : IPrincipal

The GenericPrincipal type exposes the following members.

Public methodGenericPrincipalInitializes a new instance of the GenericPrincipal class from a user identity and an array of role names to which the user represented by that identity belongs.

Public propertyIdentityGets the GenericIdentity of the user represented by the current GenericPrincipal.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsInRoleDetermines whether the current GenericPrincipal belongs to the specified role.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class represents the roles of the current user.

The following example shows the use of members of the GenericPrincipal class.

using System;
using System.Security.Principal;

class GenericPrincipalMembers
    static void Main(string[] args)
        // Retrieve a GenericPrincipal that is based on the current user's
        // WindowsIdentity.
        GenericPrincipal genericPrincipal = GetGenericPrincipal();

        // Retrieve the generic identity of the GenericPrincipal object.
        GenericIdentity principalIdentity = 

        // Display the identity name and authentication type.
        if (principalIdentity.IsAuthenticated)

        // Verify that the generic principal has been assigned the
        // NetworkUser role.
        if (genericPrincipal.IsInRole("NetworkUser"))
            Console.WriteLine("User belongs to the NetworkUser role.");

        Console.WriteLine("The sample completed successfully; " +
            "press Enter to continue.");

    // Create a generic principal based on values from the current
    // WindowsIdentity.
    private static GenericPrincipal GetGenericPrincipal()
        // Use values from the current WindowsIdentity to construct
        // a set of GenericPrincipal roles.
        WindowsIdentity windowsIdentity = WindowsIdentity.GetCurrent();
        string[] roles = new string[10];
        if (windowsIdentity.IsAuthenticated)
            // Add custom NetworkUser role.
            roles[0] = "NetworkUser";

        if (windowsIdentity.IsGuest)
            // Add custom GuestUser role.
            roles[1] = "GuestUser";

        if (windowsIdentity.IsSystem)
            // Add custom SystemUser role.
            roles[2] = "SystemUser";

        // Construct a GenericIdentity object based on the current Windows
        // identity name and authentication type.
        string authenticationType = windowsIdentity.AuthenticationType;
        string userName = windowsIdentity.Name;
        GenericIdentity genericIdentity =
            new GenericIdentity(userName, authenticationType);

        // Construct a GenericPrincipal object based on the generic identity
        // and custom roles for the user.
        GenericPrincipal genericPrincipal =
            new GenericPrincipal(genericIdentity, roles);

        return genericPrincipal;

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.