Class ClaimsIdentityBuilder

Builder to construct a new ClaimsIdentity

Inheritance
Object
ClaimsIdentityBuilder
Namespace: SuperOffice.Security.Claims
Assembly: SuperOffice.Plugins.dll
Syntax
public class ClaimsIdentityBuilder : Object

Constructors

ClaimsIdentityBuilder(IEnumerable<Claim>, String)

Create a new builder based on an existing list of claims and an authentication type

Declaration
public ClaimsIdentityBuilder(IEnumerable<Claim> claims, string authenticationType = null)
Parameters
Type Name Description
IEnumerable<Claim> claims
String authenticationType
Remarks

An authentication type is required for the resulting Claims Identity to be IsAuthenticated.

ClaimsIdentityBuilder(ClaimsIdentity)

Create new builder based on an existing identity

Declaration
public ClaimsIdentityBuilder(ClaimsIdentity identity)
Parameters
Type Name Description
ClaimsIdentity identity

ClaimsIdentityBuilder(String)

Create a new builder with a provided authentication type

Declaration
public ClaimsIdentityBuilder(string authenticationType = null)
Parameters
Type Name Description
String authenticationType
Remarks

An authentication type is required for the resulting Claims Identity to be IsAuthenticated.

Properties

AuthenticationType

Builder to construct a new ClaimsIdentity

Declaration
public string AuthenticationType { get; }
Property Value
Type Description
String

Claims

List of currently held claims

Declaration
public IEnumerable<Claim> Claims { get; }
Property Value
Type Description
IEnumerable<Claim>

Methods

AddClaim(Claim)

Add claim to the list of claims

Declaration
public ClaimsIdentityBuilder AddClaim(Claim claim)
Parameters
Type Name Description
Claim claim
Returns
Type Description
ClaimsIdentityBuilder

AddClaim(String, DateTime)

Add a claim of type DateTime to the list of claims.

Declaration
public ClaimsIdentityBuilder AddClaim(string type, DateTime value)
Parameters
Type Name Description
String type
DateTime value
Returns
Type Description
ClaimsIdentityBuilder

AddClaim(String, Int32)

Add an integer claim with value type Integer32 to the list of claims

Declaration
public ClaimsIdentityBuilder AddClaim(string type, int value)
Parameters
Type Name Description
String type
Int32 value
Returns
Type Description
ClaimsIdentityBuilder

AddClaim(String, Int64)

Add a claim of type Integer64 to the list of claims

Declaration
public ClaimsIdentityBuilder AddClaim(string type, long value)
Parameters
Type Name Description
String type
Int64 value
Returns
Type Description
ClaimsIdentityBuilder

AddClaim(String, String)

Add a claim with type and value of string to list of claims

Declaration
public ClaimsIdentityBuilder AddClaim(string type, string value)
Parameters
Type Name Description
String type
String value
Returns
Type Description
ClaimsIdentityBuilder

AddClaims(IEnumerable<Claim>)

Add multiple claims to the list of claims.

Declaration
public ClaimsIdentityBuilder AddClaims(IEnumerable<Claim> claims)
Parameters
Type Name Description
IEnumerable<Claim> claims
Returns
Type Description
ClaimsIdentityBuilder

AddClaims(Claim[])

Add multiple claims to the list of claims.

Declaration
public ClaimsIdentityBuilder AddClaims(params Claim[] claims)
Parameters
Type Name Description
Claim[] claims
Returns
Type Description
ClaimsIdentityBuilder

Build()

Construct a new ClaimsIdentity with the current list of claims and authentication type as provided in the constructor.

Declaration
public ClaimsIdentity Build()
Returns
Type Description
ClaimsIdentity
Remarks

Duplicate claims with same type and values will be removed. If ClaimsIdentityBuilder was constructed using a ClaimsIdentity, the authentication type will be inherited from the original identity.

GetClaimValues(String)

Get all values of claim with the provided type

Declaration
public IEnumerable<string> GetClaimValues(string claimType)
Parameters
Type Name Description
String claimType
Returns
Type Description
IEnumerable<String>

RemoveClaim(Claim)

Remove a particular instance of a claim from the list of claims.

Declaration
public ClaimsIdentityBuilder RemoveClaim(Claim claim)
Parameters
Type Name Description
Claim claim
Returns
Type Description
ClaimsIdentityBuilder

RemoveClaims(String)

Remove all claims of the provided type from the list of claims

Declaration
public ClaimsIdentityBuilder RemoveClaims(string type)
Parameters
Type Name Description
String type
Returns
Type Description
ClaimsIdentityBuilder

Extension Methods

EnumUtil.MapEnums<From, To>(From)