Class FromClaimAttribute

properties decorated with this attribute will have their values auto bound from the relevant claim of the current user principal

Inheritance
object
Attribute
FromClaimAttribute
FromAttribute
Inherited Members
Namespace: FastEndpoints
Assembly: FastEndpoints.Attributes.dll
Syntax
[AttributeUsage(AttributeTargets.Property)]
public class FromClaimAttribute : Attribute

Constructors

FromClaimAttribute(bool, bool)

properties decorated with this attribute will have their values auto bound from the relevant claim of the current user principal

Declaration
public FromClaimAttribute(bool isRequired, bool removeFromSchema = false)
Parameters
Type Name Description
bool isRequired

set to false if a validation error shouldn't be thrown when the current user principal doesn't have a claim type matching the property name being bound to.
bool removeFromSchema

set to true if your header is not required but shouldn't be added to schema model.

FromClaimAttribute(string?, bool, bool)

properties decorated with this attribute will have their values auto bound from the relevant claim of the current user principal

Declaration
public FromClaimAttribute(string? claimType = null, bool isRequired = true, bool removeFromSchema = false)
Parameters
Type Name Description
string claimType

optionally specify the claim type to bind from. if not specified, the claim type of the user principal must match the name of the property being bound to.
bool isRequired

set to false if a validation error shouldn't be thrown when the current user principal doesn't have the specified claim type
bool removeFromSchema

set to true if your header is not required but shouldn't be added to schema model.

Properties

ClaimType

the claim type to auto bind

Declaration
public string? ClaimType { get; set; }
Property Value
Type Description
string

IsRequired

set to true if a validation error should be thrown when the current user principal doesn't have the specified claim

Declaration
public bool IsRequired { get; set; }
Property Value
Type Description
bool

RemoveFromSchema

set to true if your header is not required but shouldn't be added to schema model

Declaration
public bool RemoveFromSchema { get; set; }
Property Value
Type Description
bool