WindowsPrincipal Class

Definition

public ref class WindowsPrincipal : System::Security::Claims::ClaimsPrincipal

public ref class WindowsPrincipal : System::Security::Principal::IPrincipal

public class WindowsPrincipal : System.Security.Claims.ClaimsPrincipal

[System.Serializable]
public class WindowsPrincipal : System.Security.Principal.IPrincipal

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class WindowsPrincipal : System.Security.Principal.IPrincipal

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class WindowsPrincipal : System.Security.Claims.ClaimsPrincipal

type WindowsPrincipal = class
 inherit ClaimsPrincipal

[<System.Serializable>]
type WindowsPrincipal = class
 interface IPrincipal

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type WindowsPrincipal = class
 interface IPrincipal

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type WindowsPrincipal = class
 inherit ClaimsPrincipal

Public Class WindowsPrincipal
Inherits ClaimsPrincipal

Public Class WindowsPrincipal
Implements IPrincipal

Inheritance

Object

ClaimsPrincipal

WindowsPrincipal

Inheritance

Object

WindowsPrincipal

Attributes

SerializableAttribute ComVisibleAttribute

Implements

IPrincipal

Examples

The following example demonstrates how to use the IsInRole method overloads. The WindowsBuiltInRole enumeration is used as the source for the relative identifiers (RIDs) that identify the built-in roles. The RIDs are used to determine the roles of the current principal.

public:
 static void DemonstrateWindowsBuiltInRoleEnum()
 {
 AppDomain^ myDomain = Thread::GetDomain();

 myDomain->SetPrincipalPolicy( PrincipalPolicy::WindowsPrincipal );
 WindowsPrincipal^ myPrincipal = dynamic_cast<WindowsPrincipal^>(Thread::CurrentPrincipal);

 Console::WriteLine( "{0} belongs to: ", myPrincipal->Identity->Name );

 Array^ wbirFields = Enum::GetValues( WindowsBuiltInRole::typeid );

 for each ( Object^ roleName in wbirFields )
 {
 try
 {
 Console::WriteLine( "{0}? {1}.", roleName,
 myPrincipal->IsInRole( *dynamic_cast<WindowsBuiltInRole^>(roleName) ) );
 }
 catch ( Exception^ ) 
 {
 Console::WriteLine( "{0}: Could not obtain role for this RID.",
 roleName );
 }
 }
 }

using System;
using System.Threading;
using System.Security.Permissions;
using System.Security.Principal;

class SecurityPrincipalDemo
{
 public static void DemonstrateWindowsBuiltInRoleEnum()
 {
 AppDomain myDomain = Thread.GetDomain();

 myDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal);
 WindowsPrincipal myPrincipal = (WindowsPrincipal)Thread.CurrentPrincipal;
 Console.WriteLine("{0} belongs to: ", myPrincipal.Identity.Name.ToString());
 Array wbirFields = Enum.GetValues(typeof(WindowsBuiltInRole));
 foreach (object roleName in wbirFields)
 {
 try
 {
 // Cast the role name to a RID represented by the WindowsBuildInRole value.
 Console.WriteLine("{0}? {1}.", roleName,
 myPrincipal.IsInRole((WindowsBuiltInRole)roleName));
 Console.WriteLine("The RID for this role is: " + ((int)roleName).ToString());
 }
 catch (Exception)
 {
 Console.WriteLine("{0}: Could not obtain role for this RID.",
 roleName);
 }
 }
 // Get the role using the string value of the role.
 Console.WriteLine("{0}? {1}.", "Administrators",
 myPrincipal.IsInRole("BUILTIN\\" + "Administrators"));
 Console.WriteLine("{0}? {1}.", "Users",
 myPrincipal.IsInRole("BUILTIN\\" + "Users"));
 // Get the role using the WindowsBuiltInRole enumeration value.
 Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator,
 myPrincipal.IsInRole(WindowsBuiltInRole.Administrator));
 // Get the role using the WellKnownSidType.
 SecurityIdentifier sid = new SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, null);
 Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid));
 }

 public static void Main()
 {
 DemonstrateWindowsBuiltInRoleEnum();
 }
}

Imports System.Threading
Imports System.Security.Permissions
Imports System.Security.Principal

Class SecurityPrincipalDemo

 Public Shared Sub DemonstrateWindowsBuiltInRoleEnum()
 Dim myDomain As AppDomain = Thread.GetDomain()

 myDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal)
 Dim myPrincipal As WindowsPrincipal = CType(Thread.CurrentPrincipal, WindowsPrincipal)
 Console.WriteLine("{0} belongs to: ", myPrincipal.Identity.Name.ToString())
 Dim wbirFields As Array = [Enum].GetValues(GetType(WindowsBuiltInRole))
 Dim roleName As Object
 For Each roleName In wbirFields
 Try
 ' Cast the role name to a RID represented by the WindowsBuildInRole value.
 Console.WriteLine("{0}? {1}.", roleName, myPrincipal.IsInRole(CType(roleName, WindowsBuiltInRole)))
 Console.WriteLine("The RID for this role is: " + Fix(roleName).ToString())

 Catch
 Console.WriteLine("{0}: Could not obtain role for this RID.", roleName)
 End Try
 Next roleName
 ' Get the role using the string value of the role.
 Console.WriteLine("{0}? {1}.", "Administrators", myPrincipal.IsInRole("BUILTIN\" + "Administrators"))
 Console.WriteLine("{0}? {1}.", "Users", myPrincipal.IsInRole("BUILTIN\" + "Users"))
 ' Get the role using the WindowsBuiltInRole enumeration value.
 Console.WriteLine("{0}? {1}.", WindowsBuiltInRole.Administrator, myPrincipal.IsInRole(WindowsBuiltInRole.Administrator))
 ' Get the role using the WellKnownSidType.
 Dim sid As New SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, Nothing)
 Console.WriteLine("WellKnownSidType BuiltinAdministratorsSid {0}? {1}.", sid.Value, myPrincipal.IsInRole(sid))

 End Sub

 Public Shared Sub Main()
 DemonstrateWindowsBuiltInRoleEnum()

 End Sub
End Class

Remarks

The WindowsPrincipal class is primarily used to check the role of a Windows user. The WindowsPrincipal.IsInRole method overloads let you check the user role by using different role contexts.