WindowsClaimsPrincipal.IsInRole Method (String)

Article
2012-10-05

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Returns a value that indicates whether this principal is in the role of the specified security identifier (SID). The SID is specified as a string.

Namespace: Microsoft.IdentityModel.Claims
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As WindowsClaimsPrincipal
Dim role As String
Dim returnValue As Boolean

returnValue = instance.IsInRole(role)

Syntax

'Declaration
Public Overrides Function IsInRole ( _
    role As String _
) As Boolean

public override bool IsInRole (
    string role
)

public:
virtual bool IsInRole (
    String^ role
) override

public boolean IsInRole (
    String role
)

public override function IsInRole (
    role : String
) : boolean

Parameters

role
The claim value of the role that should be searched for on the contained identities; for example, “BUILTIN\Administrators”.

Return Value

true if the role exists as a Windows group or as a value on a role claim type in one of the contained IClaimsIdentity objects; otherwise, false.

Remarks

The method determines whether the principal contains a matching group security identifier or whether one of the principal’s contained identities possesses a matching claim value for the claim type that is specified by that identity’s RoleClaimType property. The identities associated with the principal can be accessed through the Identities property.

Thread Safety

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

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via