IsInRole Method

ClaimsPrincipal.IsInRole Method (String)

.NET Framework 4.6 and 4.5

Returns a value that indicates whether the entity (user) represented by this claims principal is in the specified role.

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

Public Overridable Function IsInRole (
	role As String
) As Boolean


Type: System.String

The role for which to check.

Return Value

Type: System.Boolean

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

The IsInRole method checks whether an identity that this claims principal possesses contains a claim of type ClaimsIdentity.RoleClaimType where the value of the claim is equal to the value specified by the role parameter.


Each ClaimsIdentity has its own definition of the claim type that represents a role. This claim type can be accessed and set through the ClaimsIdentity.RoleClaimType property.

Universal Windows Platform
Available since 10
.NET Framework
Available since 4.5
Return to top
© 2015 Microsoft