ClaimsPrincipal

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

Name	Type	Description
`claimsPrincipal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance to check for Claims. Should be Current, except in unit testing.
`claimType`	`string`	-

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

Name	Type	Description
`claimsPrincipal`	`System.Security.Claims.ClaimsPrincipal`	-
`claimType`	`string`	-

Returns

Type: System.Guid

Exceptions

Exception	Description
`FormatException`	If 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

Name	Type	Description
`claimsPrincipal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance to check for Claims. Should be Current, except in unit testing.
`claimType`	`string`	-

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

Name	Type	Description
`principal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance we’re extending.

Returns

Type: System.Guid

TryGetIdClaim Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Gets the current User’s ID claim as a Guid, without throwing when the claim is missing or malformed.

Syntax

public static bool TryGetIdClaim(System.Security.Claims.ClaimsPrincipal principal, out System.Guid id)

Parameters

Name	Type	Description
`principal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance we’re extending.
`id`	`System.Guid`	The ID, or Empty when the claim is missing or not a valid Guid.

Returns

Type: bool true if the claim exists and is a valid Guid; otherwise, false.

TryGetIdClaim Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Gets the current User’s ID claim as an Int32, for applications whose user IDs are integers.

Syntax

public static bool TryGetIdClaim(System.Security.Claims.ClaimsPrincipal principal, out int id)

Parameters

Name	Type	Description
`principal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance we’re extending.
`id`	`int`	The ID, or 0 when the claim is missing or not a valid Int32.

Returns

Type: bool true if the claim exists and is a valid Int32; otherwise, false.

TryGetIdClaim Extension

Extension method from System.Security.Claims.EasyAF_ClaimsPrincipalExtensions

Gets the current User’s ID claim as a Int64, for applications whose user IDs are 64-bit integers.

Syntax

public static bool TryGetIdClaim(System.Security.Claims.ClaimsPrincipal principal, out long id)

Parameters

Name	Type	Description
`principal`	`System.Security.Claims.ClaimsPrincipal`	The ClaimsPrincipal instance we’re extending.
`id`	`long`	The ID, or 0 when the claim is missing or not a valid Int64.

Returns

Type: bool true if the claim exists and is a valid Int64; otherwise, false.

Getting Started

Guides

API Reference

ClaimsPrincipal

Definition

Syntax

Summary

Remarks

Methods

GetAllClaims Extension

Syntax

Parameters

Returns

GetClaimGuid Extension

Syntax

Parameters

Returns

Exceptions

GetClaimValue Extension

Syntax

Parameters

Returns

GetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns

​Definition

​Syntax

​Summary

​Remarks

​Methods

​ GetAllClaims Extension

​Syntax

​Parameters

​Returns

​ GetClaimGuid Extension

​Syntax

​Parameters

​Returns

​Exceptions

​ GetClaimValue Extension

​Syntax

​Parameters

​Returns

​ GetIdClaim Extension

​Syntax

​Parameters

​Returns

​ TryGetIdClaim Extension

​Syntax

​Parameters

​Returns

​ TryGetIdClaim Extension

​Syntax

​Parameters

​Returns

​ TryGetIdClaim Extension

​Syntax

​Parameters

​Returns

Definition

Syntax

Summary

Remarks

Methods

GetAllClaims Extension

Syntax

Parameters

Returns

GetClaimGuid Extension

Syntax

Parameters

Returns

Exceptions

GetClaimValue Extension

Syntax

Parameters

Returns

GetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns

TryGetIdClaim Extension

Syntax

Parameters

Returns