ClaimsIdentity.RoleClaimType Property

Definition

Gets the claim type that will be interpreted as a .NET role among the claims in this claims identity.

C#
public string RoleClaimType { get; }

Property Value

The role claim type.

Remarks

The role claim type is the claim type (Claim.Type) that is used when evaluating this identity for the ClaimsPrincipal.IsInRole(String) method. The ClaimsPrincipal.IsInRole(String) method is called to determine whether the current principal is in a specified role. The claims-based model extends this check to use claims presented by the principal. A ClaimsPrincipal object can contain one or more ClaimsIdentity objects and each identity object can contain multiple Claim objects. The RoleClaimType property specifies the claim type of the claim that should be used to provide the value for the role when evaluating this ClaimsIdentity object. The property is set by the constructor. A common value is ClaimTypes.Role.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

See also