Skip to main content

Definition

Assembly: System.Security.Claims.dll Namespace: System.Security.Claims

Syntax

System.Security.Claims.ClaimsPrincipal

Summary

This type is defined in System.Security.Claims.

Remarks

See Microsoft documentation for more information about the rest of the API.

Methods

GetAllClaims Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Syntax

public static System.Collections.Generic.IEnumerable<System.Security.Claims.Claim> GetAllClaims(System.Security.Claims.ClaimsPrincipal claimsPrincipal, string claimType)

Parameters

NameTypeDescription
claimsPrincipalSystem.Security.Claims.ClaimsPrincipalThe ClaimsPrincipal instance to check for Claims. Should be Current, except in unit testing.
claimTypestring-

Returns

Type: System.Collections.Generic.IEnumerable<System.Security.Claims.Claim>

GetClaimGuid Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Syntax

public static System.Guid GetClaimGuid(System.Security.Claims.ClaimsPrincipal claimsPrincipal, string claimType)

Parameters

NameTypeDescription
claimsPrincipalSystem.Security.Claims.ClaimsPrincipal-
claimTypestring-

Returns

Type: System.Guid

Exceptions

ExceptionDescription
FormatExceptionIf the claimType is not formatted like a Guid (32 characters with 4 dashes), this exception will be thrown.

GetClaimValue Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Syntax

public static string GetClaimValue(System.Security.Claims.ClaimsPrincipal claimsPrincipal, string claimType)

Parameters

NameTypeDescription
claimsPrincipalSystem.Security.Claims.ClaimsPrincipalThe ClaimsPrincipal instance to check for Claims. Should be Current, except in unit testing.
claimTypestring-

Returns

Type: string

GetIdClaim Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions
A shortcut for returning the AppUserProfileId for the current User.

Syntax

public static System.Guid GetIdClaim(System.Security.Claims.ClaimsPrincipal principal)

Parameters

NameTypeDescription
principalSystem.Security.Claims.ClaimsPrincipalThe ClaimsPrincipal instance we’re extending.

Returns

Type: System.Guid