GenericPrincipal Class

GenericPrincipal Class

 

Represents a generic principal.

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

System.Object
  System.Security.Claims.ClaimsPrincipal
    System.Security.Principal.GenericPrincipal
      System.Web.Security.PassportPrincipal

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class GenericPrincipal : ClaimsPrincipal

NameDescription
System_CAPS_pubmethodGenericPrincipal(IIdentity, String[])

Initializes 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.

NameDescription
System_CAPS_pubpropertyClaims

Gets a collection that contains all of the claims from all of the claims identities associated with this claims principal.(Inherited from ClaimsPrincipal.)

System_CAPS_protpropertyCustomSerializationData

(Inherited from ClaimsPrincipal.)

System_CAPS_pubpropertyIdentities

Gets a collection that contains all of the claims identities associated with this claims principal.(Inherited from ClaimsPrincipal.)

System_CAPS_pubpropertyIdentity

Gets the GenericIdentity of the user represented by the current GenericPrincipal.(Overrides ClaimsPrincipal.Identity.)

NameDescription
System_CAPS_pubmethodAddIdentities(IEnumerable<ClaimsIdentity>)

Adds the specified claims identities to this claims principal.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodAddIdentity(ClaimsIdentity)

Adds the specified claims identity to this claims principal.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodClone()

Returns a copy of this instance.(Inherited from ClaimsPrincipal.)

System_CAPS_protmethodCreateClaimsIdentity(BinaryReader)

Creates a new claims identity.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindAll(Predicate<Claim>)

Retrieves all of the claims that are matched by the specified predicate.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodFindAll(String)

Retrieves all or the claims that have the specified claim type.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodFindFirst(Predicate<Claim>)

Retrieves the first claim that is matched by the specified predicate.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodFindFirst(String)

Retrieves the first claim with the specified claim type.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_protmethodGetObjectData(SerializationInfo, StreamingContext)

Populates the SerializationInfo with data needed to serialize the current ClaimsPrincipal object.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodHasClaim(Predicate<Claim>)

Determines whether any of the claims identities associated with this claims principal contains a claim that is matched by the specified predicate.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodHasClaim(String, String)

Determines whether any of the claims identities associated with this claims principal contains a claim with the specified claim type and value.(Inherited from ClaimsPrincipal.)

System_CAPS_pubmethodIsInRole(String)

Determines whether the current GenericPrincipal belongs to the specified role.(Overrides ClaimsPrincipal.IsInRole(String).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWriteTo(BinaryWriter)

(Inherited from ClaimsPrincipal.)

System_CAPS_protmethodWriteTo(BinaryWriter, Byte[])

(Inherited from ClaimsPrincipal.)

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
{
    [STAThread]
    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 = 
            (GenericIdentity)genericPrincipal.Identity;

        // Display the identity name and authentication type.
        if (principalIdentity.IsAuthenticated)
        {
            Console.WriteLine(principalIdentity.Name);
            Console.WriteLine("Type:"+principalIdentity.AuthenticationType);
        }

        // 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.");
        Console.ReadLine();
    }

    // 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;
    }
}

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft