Class ClaimsPrincipalExtensions

Extension for retriving or quering claims.

Inheritance

System.Object

ClaimsPrincipalExtensions

Namespace: ISynergy.Framework.Core.Extensions

Assembly: ISynergy.Framework.Core.dll

Syntax

public static class ClaimsPrincipalExtensions : object

Methods

FindFirstValue(IEnumerable<Claim>, String)

Finds the first value.

Declaration

public static string FindFirstValue(this IEnumerable<Claim> claims, string claimType)

Parameters

Type	Name	Description
IEnumerable<Claim>	claims	The claims.
System.String	claimType	Type of the claim.

Returns

Type	Description
System.String	System.String.

FindSingleValue(IEnumerable<Claim>, String)

Finds the single value.

Declaration

public static string FindSingleValue(this IEnumerable<Claim> claims, string claimType)

Parameters

Type	Name	Description
IEnumerable<Claim>	claims	The claims.
System.String	claimType	Type of the claim.

Returns

Type	Description
System.String	System.String.

FindValues(IEnumerable<Claim>, String)

Finds the values.

Declaration

public static IEnumerable<string> FindValues(this IEnumerable<Claim> claims, string claimType)

Parameters

Type	Name	Description
IEnumerable<Claim>	claims	The claims.
System.String	claimType	Type of the claim.

Returns

Type	Description
IEnumerable<System.String>	IEnumerable<System.String>.

GetAccountId(ClaimsPrincipal)

Get AccountId from claims.

Declaration

public static Guid GetAccountId(this ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal

Returns

Type	Description
Guid	Guid.

GetClaims(ClaimsPrincipal, String)

Gets the claims.

Declaration

public static List<string> GetClaims(this ClaimsPrincipal principal, string claimType)

Parameters

Type	Name	Description
ClaimsPrincipal	principal
System.String	claimType	Type of the claim.

Returns

Type	Description
List<System.String>	List<System.String>.

Exceptions

Type	Condition
ClaimNotFoundException

GetClientId(ClaimsPrincipal)

Get clientId from claims.

Declaration

public static Guid GetClientId(this ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal

Returns

Type	Description
Guid	Guid.

GetSecurityStamp(ClaimsPrincipal)

Get SecurityStamp from claims.

Declaration

public static string GetSecurityStamp(this ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal

Returns

Type	Description
System.String	System.String.

GetUserId(ClaimsPrincipal)

Get UserId from claims.

Declaration

public static Guid GetUserId(this ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal

Returns

Type	Description
Guid	Guid.

GetUserName(ClaimsPrincipal)

Get Username from claims.

Declaration

public static string GetUserName(this ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal

Returns

Type	Description
System.String	System.String.

HasClaim(ClaimsPrincipal, String)

Determines whether the specified claim type has claim.

Declaration

public static bool HasClaim(this ClaimsPrincipal principal, string claimType)

Parameters

Type	Name	Description
ClaimsPrincipal	principal
System.String	claimType	Type of the claim.

Returns

Type	Description
System.Boolean	true if the specified claim type has claim; otherwise, false.