WindowsIdentity Class

WindowsIdentity Class

 

Represents a Windows user.

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

System.Object
  System.Security.Claims.ClaimsIdentity
    System.Security.Principal.WindowsIdentity

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class WindowsIdentity : ClaimsIdentity, ISerializable, 
	IDeserializationCallback, IDisposable

NameDescription
System_CAPS_pubmethodWindowsIdentity(IntPtr)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified Windows account token.

System_CAPS_pubmethodWindowsIdentity(IntPtr, String)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified Windows account token and the specified authentication type.

System_CAPS_pubmethodWindowsIdentity(IntPtr, String, WindowsAccountType)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified Windows account token, the specified authentication type, and the specified Windows account type.

System_CAPS_pubmethodWindowsIdentity(IntPtr, String, WindowsAccountType, Boolean)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified Windows account token, the specified authentication type, the specified Windows account type, and the specified authentication status.

System_CAPS_pubmethodWindowsIdentity(SerializationInfo, StreamingContext)

Initializes a new instance of the WindowsIdentity class for the user represented by information in a SerializationInfo stream.

System_CAPS_pubmethodWindowsIdentity(String)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified User Principal Name (UPN).

System_CAPS_pubmethodWindowsIdentity(String, String)

Initializes a new instance of the WindowsIdentity class for the user represented by the specified User Principal Name (UPN) and the specified authentication type.

System_CAPS_protmethodWindowsIdentity(WindowsIdentity)

Initializes a new instance of the WindowsIdentity class by using the specified WindowsIdentity object.

NameDescription
System_CAPS_pubpropertyAccessToken

Gets this SafeAccessTokenHandle for this WindowsIdentity instance.

System_CAPS_pubpropertyActor

Gets or sets the identity of the calling party that was granted delegation rights.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyAuthenticationType

Gets the type of authentication used to identify the user.(Overrides ClaimsIdentity.AuthenticationType.)

System_CAPS_pubpropertyBootstrapContext

Gets or sets the token that was used to create this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyClaims

Gets all claims for the user represented by this Windows identity.(Overrides ClaimsIdentity.Claims.)

System_CAPS_protpropertyCustomSerializationData

(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyDeviceClaims

Gets claims that have the ClaimTypes.WindowsDeviceClaim property key.

System_CAPS_pubpropertyGroups

Gets the groups the current Windows user belongs to.

System_CAPS_pubpropertyImpersonationLevel

Gets the impersonation level for the user.

System_CAPS_pubpropertyIsAnonymous

Gets a value that indicates whether the user account is identified as an anonymous account by the system.

System_CAPS_pubpropertyIsAuthenticated

Gets a value indicating whether the user has been authenticated by Windows.(Overrides ClaimsIdentity.IsAuthenticated.)

System_CAPS_pubpropertyIsGuest

Gets a value indicating whether the user account is identified as a Guest account by the system.

System_CAPS_pubpropertyIsSystem

Gets a value indicating whether the user account is identified as a System account by the system.

System_CAPS_pubpropertyLabel

Gets or sets the label for this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyName

Gets the user's Windows logon name.(Overrides ClaimsIdentity.Name.)

System_CAPS_pubpropertyNameClaimType

Gets the claim type that is used to determine which claims provide the value for the Name property of this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyOwner

Gets the security identifier (SID) for the token owner.

System_CAPS_pubpropertyRoleClaimType

Gets the claim type that will be interpreted as a .NET Framework role among the claims in this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubpropertyToken

Gets the Windows account token for the user.

System_CAPS_pubpropertyUser

Gets the security identifier (SID) for the user.

System_CAPS_pubpropertyUserClaims

Gets claims that have the ClaimTypes.WindowsUserClaim property key.

NameDescription
System_CAPS_pubmethodAddClaim(Claim)

Adds a single claim to this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodAddClaims(IEnumerable<Claim>)

Adds a list of claims to this claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodClone()

Creates a new object that is a copy of the current instance.(Overrides ClaimsIdentity.Clone().)

System_CAPS_protmethodCreateClaim(BinaryReader)

(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodDispose()

Releases all resources used by the WindowsIdentity.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the WindowsIdentity and optionally releases the managed resources.

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 ClaimsIdentity.)

System_CAPS_pubmethodFindAll(String)

Retrieves all of the claims that have the specified claim type.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodFindFirst(Predicate<Claim>)

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

System_CAPS_pubmethodFindFirst(String)

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

System_CAPS_pubmethodSystem_CAPS_staticGetAnonymous()

Returns a WindowsIdentity object that you can use as a sentinel value in your code to represent an anonymous user. The property value does not represent the built-in anonymous identity used by the Windows operating system.

System_CAPS_pubmethodSystem_CAPS_staticGetCurrent()

Returns a WindowsIdentity object that represents the current Windows user.

System_CAPS_pubmethodSystem_CAPS_staticGetCurrent(Boolean)

Returns a WindowsIdentity object that represents the Windows identity for either the thread or the process, depending on the value of the ifImpersonating parameter.

System_CAPS_pubmethodSystem_CAPS_staticGetCurrent(TokenAccessLevels)

Returns a WindowsIdentity object that represents the current Windows user, using the specified desired token access level.

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 ClaimsIdentity object.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodHasClaim(Predicate<Claim>)

Determines whether this claims identity has a claim that is matched by the specified predicate.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodHasClaim(String, String)

Determines whether this claims identity has a claim with the specified claim type and value.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodImpersonate()

Impersonates the user represented by the WindowsIdentity object.

System_CAPS_pubmethodSystem_CAPS_staticImpersonate(IntPtr)

Impersonates the user represented by the specified user token.

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_pubmethodRemoveClaim(Claim)

Attempts to remove a claim from the claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodSystem_CAPS_staticRunImpersonated(SafeAccessTokenHandle, Action)

Runs the specified action as the impersonated Windows identity. Instead of using an impersonated method call and running your function in WindowsImpersonationContext, you can use RunImpersonated and provide your function directly as a parameter.

System_CAPS_pubmethodSystem_CAPS_staticRunImpersonated<T>(SafeAccessTokenHandle, Func<T>)

Runs the specified function as the impersonated Windows identity. Instead of using an impersonated method call and running your function in WindowsImpersonationContext, you can use RunImpersonated and provide your function directly as a parameter.

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodTryRemoveClaim(Claim)

Attempts to remove a claim from the claims identity.(Inherited from ClaimsIdentity.)

System_CAPS_pubmethodWriteTo(BinaryWriter)

(Inherited from ClaimsIdentity.)

System_CAPS_protmethodWriteTo(BinaryWriter, Byte[])

(Inherited from ClaimsIdentity.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefaultIssuer

Identifies the name of the default ClaimsIdentity issuer.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDeserializationCallback.OnDeserialization(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Implements the ISerializable interface and is called back by the deserialization event when deserialization is complete.

System_CAPS_pubinterfaceSystem_CAPS_privmethodISerializable.GetObjectData(SerializationInfo, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the SerializationInfo object with the logical context information needed to recreate an instance of this execution context.

Call the GetCurrent method to create a WindowsIdentity object that represents the current user.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

The following example shows the use of members of WindowsIdentity class. For an example showing how to obtain a Windows account token through a call to the unmanaged Win32 LogonUser function, and use that token to impersonate another user, see the WindowsImpersonationContext class.

using System;
using System.Security.Principal;

class WindowsIdentityMembers
{
    [STAThread]
    static void Main(string[] args)
    {
        // Retrieve the Windows account token for the current user.
        IntPtr logonToken = LogonUser();

        // Constructor implementations.
        IntPtrConstructor(logonToken);
        IntPtrStringConstructor(logonToken);
        IntPtrStringTypeConstructor(logonToken);
        IntPrtStringTypeBoolConstructor(logonToken);

        // Property implementations.
        UseProperties(logonToken);

        // Method implementations.
        GetAnonymousUser();
        ImpersonateIdentity(logonToken);

        Console.WriteLine("This sample completed successfully; " +
            "press Enter to exit.");
        Console.ReadLine();
    }

    // Create a WindowsIdentity object for the user represented by the
    // specified Windows account token.
    private static void IntPtrConstructor(IntPtr logonToken)
    {
        // Construct a WindowsIdentity object using the input account token.
        WindowsIdentity windowsIdentity = new WindowsIdentity(logonToken);

        Console.WriteLine("Created a Windows identity object named " +
            windowsIdentity.Name + ".");
    }


    // Create a WindowsIdentity object for the user represented by the
    // specified account token and authentication type.
    private static void IntPtrStringConstructor(IntPtr logonToken)
    {
        // Construct a WindowsIdentity object using the input account token 
        // and the specified authentication type.
        string authenticationType = "WindowsAuthentication";
        WindowsIdentity windowsIdentity =
			            new WindowsIdentity(logonToken, authenticationType);

        Console.WriteLine("Created a Windows identity object named " +
            windowsIdentity.Name + ".");
    }

    // Create a WindowsIdentity object for the user represented by the
    // specified account token, authentication type, and Windows account
    // type.
    private static void IntPtrStringTypeConstructor(IntPtr logonToken)
    {
        // Construct a WindowsIdentity object using the input account token,
        // and the specified authentication type, and Windows account type.
        string authenticationType = "WindowsAuthentication";
        WindowsAccountType guestAccount = WindowsAccountType.Guest;
        WindowsIdentity windowsIdentity =
            new WindowsIdentity(logonToken, authenticationType, guestAccount);

        Console.WriteLine("Created a Windows identity object named " +
            windowsIdentity.Name + ".");
    }

    // Create a WindowsIdentity object for the user represented by the
    // specified account token, authentication type, Windows account type, and
    // Boolean authentication flag.
    private static void IntPrtStringTypeBoolConstructor(IntPtr logonToken)
    {
        // Construct a WindowsIdentity object using the input account token,
        // and the specified authentication type, Windows account type, and
        // authentication flag.
        string authenticationType = "WindowsAuthentication";
        WindowsAccountType guestAccount = WindowsAccountType.Guest;
        bool isAuthenticated = true;
        WindowsIdentity windowsIdentity = new WindowsIdentity(
            logonToken, authenticationType, guestAccount, isAuthenticated);

        Console.WriteLine("Created a Windows identity object named " +
            windowsIdentity.Name + ".");
    }
    // Access the properties of a WindowsIdentity object.
    private static void UseProperties(IntPtr logonToken)
    {
        WindowsIdentity windowsIdentity = new WindowsIdentity(logonToken);
        string propertyDescription = "The Windows identity named ";

        // Retrieve the Windows logon name from the Windows identity object.
        propertyDescription += windowsIdentity.Name;

        // Verify that the user account is not considered to be an Anonymous
        // account by the system.
        if (!windowsIdentity.IsAnonymous)
        {
            propertyDescription += " is not an Anonymous account";
        }

        // Verify that the user account has been authenticated by Windows.
        if (windowsIdentity.IsAuthenticated)
        {
            propertyDescription += ", is authenticated";
        }

        // Verify that the user account is considered to be a System account
        // by the system.
        if (windowsIdentity.IsSystem)
        {
            propertyDescription += ", is a System account";
        }
        // Verify that the user account is considered to be a Guest account
        // by the system.
        if (windowsIdentity.IsGuest)
        {
            propertyDescription += ", is a Guest account";
        }

        // Retrieve the authentication type for the 
        String authenticationType = windowsIdentity.AuthenticationType;

        // Append the authenication type to the output message.
        if (authenticationType != null)
        {
            propertyDescription += (" and uses " + authenticationType);
            propertyDescription += (" authentication type.");
        }

        Console.WriteLine(propertyDescription);

        // Display the SID for the owner.
        Console.Write("The SID for the owner is : ");
        SecurityIdentifier si = windowsIdentity.Owner;
        Console.WriteLine(si.ToString());
        // Display the SIDs for the groups the current user belongs to.
        Console.WriteLine("Display the SIDs for the groups the current user belongs to.");
        IdentityReferenceCollection irc = windowsIdentity.Groups;
        foreach (IdentityReference ir in irc)
            Console.WriteLine(ir.Value);
        TokenImpersonationLevel token = windowsIdentity.ImpersonationLevel;
        Console.WriteLine("The impersonation level for the current user is : " + token.ToString());
    }

    // Retrieve the account token from the current WindowsIdentity object
    // instead of calling the unmanaged LogonUser method in the advapi32.dll.
    private static IntPtr LogonUser()
    {
        IntPtr accountToken = WindowsIdentity.GetCurrent().Token;
        Console.WriteLine( "Token number is: " + accountToken.ToString());

        return accountToken;
    }

    // Get the WindowsIdentity object for an Anonymous user.
    private static void GetAnonymousUser()
    {
        // Retrieve a WindowsIdentity object that represents an anonymous
        // Windows user.
        WindowsIdentity windowsIdentity = WindowsIdentity.GetAnonymous();
    }

    // Impersonate a Windows identity.
    private static void ImpersonateIdentity(IntPtr logonToken)
    {
        // Retrieve the Windows identity using the specified token.
        WindowsIdentity windowsIdentity = new WindowsIdentity(logonToken);

        // Create a WindowsImpersonationContext object by impersonating the
        // Windows identity.
        WindowsImpersonationContext impersonationContext =
            windowsIdentity.Impersonate();

        Console.WriteLine("Name of the identity after impersonation: "
            + WindowsIdentity.GetCurrent().Name + ".");
        Console.WriteLine(windowsIdentity.ImpersonationLevel);
        // Stop impersonating the user.
        impersonationContext.Undo();

        // Check the identity name.
        Console.Write("Name of the identity after performing an Undo on the");
        Console.WriteLine(" impersonation: " +
            WindowsIdentity.GetCurrent().Name);
    }
}

.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