ClaimsPrincipal.IsInRole Method

Article
10/05/2012

[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 the principal is in the specified role.

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

Usage

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

returnValue = instance.IsInRole(role)

Syntax

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

public bool IsInRole (
    string role
)

public:
virtual bool IsInRole (
    String^ role
) sealed

public final boolean IsInRole (
    String role
)

public final function IsInRole (
    role : String
) : boolean

Parameters

role
The role for which to check. The role is checked against the value of claims that are configured as the role claim type through the RoleClaimType property on one or more of the claims-based identities associated with this principal.

Return Value

Returns true if the principal is in the specified role; otherwise, false.

Remarks

The principal is determined to be in the specified role if one or more of the IClaimsIdentity objects associated with it possesses a claim (Claim) with a value that matches the value specified by the role parameter and with the claim type that is configured as the role claim type for the identity through the IClaimsIdentity.RoleClaimType 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)